From: Jean-Paul Pelteret Date: Tue, 28 Aug 2018 20:09:17 +0000 (+0200) Subject: Doc fix: Correct all instances of "Adol-C" X-Git-Tag: v9.1.0-rc1~765^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F7131%2Fhead;p=dealii.git Doc fix: Correct all instances of "Adol-C" --- diff --git a/cmake/config/template-arguments.in b/cmake/config/template-arguments.in index 982316ad6f..260787b27f 100644 --- a/cmake/config/template-arguments.in +++ b/cmake/config/template-arguments.in @@ -18,7 +18,7 @@ REAL_AND_COMPLEX_SCALARS := { double; std::complex; std::complex } -// differentiable Adol-C scalar types +// differentiable ADOL-C scalar types DIFFERENTIABLE_ADOLC_REAL_SCALARS := { @DEAL_II_EXPAND_ADOLC_TYPES@; } diff --git a/include/deal.II/base/numbers.h b/include/deal.II/base/numbers.h index 90fc1034ae..97cd3ec3d9 100644 --- a/include/deal.II/base/numbers.h +++ b/include/deal.II/base/numbers.h @@ -675,7 +675,7 @@ namespace numbers * returns only whether the scalar values stored by the input values are * equal. * - * @note When Adol-C is compiled with the "advanced branching" feature, then + * @note When ADOL-C is compiled with the "advanced branching" feature, then * this specialization is only intended for use in assertions and * other code paths that do not affect the end result of a computation. */ @@ -690,7 +690,7 @@ namespace numbers * returns only whether the scalar values stored by the input values are * equal. * - * @note When Adol-C is compiled with the "advanced branching" feature, then + * @note When ADOL-C is compiled with the "advanced branching" feature, then * this specialization is only intended for use in assertions and * other code paths that do not affect the end result of a computation. */ @@ -698,7 +698,7 @@ namespace numbers bool values_are_equal(const adouble &value_1, const Number &value_2) { - // Use the specialized definition for two Adol-C taped types + // Use the specialized definition for two ADOL-C taped types return values_are_equal(value_1, internal::NumberType::value(value_2)); } @@ -710,7 +710,7 @@ namespace numbers * returns only whether the scalar values stored by the input values are * equal. * - * @note When Adol-C is compiled with the "advanced branching" feature, then + * @note When ADOL-C is compiled with the "advanced branching" feature, then * this specialization is only intended for use in assertions and * other code paths that do not affect the end result of a computation. */ @@ -729,7 +729,7 @@ namespace numbers * this function returns the result of the comparison of scalar values stored * by the input arguments. * - * @note When Adol-C is compiled with the "advanced branching" feature, then + * @note When ADOL-C is compiled with the "advanced branching" feature, then * this specialization is only intended for use in assertions and * other code paths that do not affect the end result of a computation. */ @@ -745,7 +745,7 @@ namespace numbers * this function returns the result of the comparison of scalar values stored * by the input arguments. * - * @note When Adol-C is compiled with the "advanced branching" feature, then + * @note When ADOL-C is compiled with the "advanced branching" feature, then * this specialization is only intended for use in assertions and * other code paths that do not affect the end result of a computation. */ @@ -753,7 +753,7 @@ namespace numbers bool value_is_less_than(const adouble &value_1, const Number &value_2) { - // Use the specialized definition for two Adol-C taped types + // Use the specialized definition for two ADOL-C taped types return value_is_less_than(value_1, internal::NumberType::value(value_2)); } @@ -766,7 +766,7 @@ namespace numbers * this function returns the result of the comparison of scalar values stored * by the input arguments. * - * @note When Adol-C is compiled with the "advanced branching" feature, then + * @note When ADOL-C is compiled with the "advanced branching" feature, then * this specialization is only intended for use in assertions and * other code paths that do not affect the end result of a computation. */ @@ -774,7 +774,7 @@ namespace numbers bool value_is_less_than(const Number &value_1, const adouble &value_2) { - // Use the specialized definition for two Adol-C taped types + // Use the specialized definition for two ADOL-C taped types return value_is_less_than(internal::NumberType::value(value_1), value_2); } diff --git a/include/deal.II/base/symmetric_tensor.templates.h b/include/deal.II/base/symmetric_tensor.templates.h index 490eddff1c..7ce41471ee 100644 --- a/include/deal.II/base/symmetric_tensor.templates.h +++ b/include/deal.II/base/symmetric_tensor.templates.h @@ -879,7 +879,7 @@ eigenvectors(const SymmetricTensor<2, dim, Number> &T, double sf = 1.0; if (Differentiation::AD::is_taped_ad_number::value) { - // Adol-C taped + // ADOL-C taped if (method == SymmetricTensorEigenvectorMethod::ql_implicit_shifts) sf = 2e11; @@ -1004,10 +1004,10 @@ eigenvectors(const SymmetricTensor<2, dim, Number> &T, #ifdef DEAL_II_ADOLC_WITH_ADVANCED_BRANCHING -// Specializations of the above functions for taped Adol-C numbers +// Specializations of the above functions for taped ADOL-C numbers // when the advanced branching feature is activated. // We could copy-paste all of these functions and add the appropriate -// conditional assignments (see the Adol-C manual, section 1.8). +// conditional assignments (see the ADOL-C manual, section 1.8). // However, some of the conditions are quite complicated (with possibly // no 1-1 correspondence for the operations along each branch) so this // needs some careful attention. For the sake of simplicity and until diff --git a/include/deal.II/base/tensor.h b/include/deal.II/base/tensor.h index 5731d38483..60261a38b8 100644 --- a/include/deal.II/base/tensor.h +++ b/include/deal.II/base/tensor.h @@ -887,7 +887,7 @@ Tensor<0, dim, Number>::operator==(const Tensor<0, dim, OtherNumber> &p) const Assert(!(std::is_same::value || std::is_same::value), ExcMessage( - "The Tensor equality operator for Adol-C taped numbers has not yet " + "The Tensor equality operator for ADOL-C taped numbers has not yet " "been extended to support advanced branching.")); #endif @@ -2385,7 +2385,7 @@ linfty_norm(const Tensor<2, dim, Number> &t) # ifdef DEAL_II_ADOLC_WITH_ADVANCED_BRANCHING -// Specialization of functions for Adol-C number types when +// Specialization of functions for ADOL-C number types when // the advanced branching feature is used template inline adouble diff --git a/include/deal.II/differentiation/ad.h b/include/deal.II/differentiation/ad.h index b51da41abf..6f7112397f 100644 --- a/include/deal.II/differentiation/ad.h +++ b/include/deal.II/differentiation/ad.h @@ -40,7 +40,7 @@ namespace Differentiation /** * Wrappers for automatic differentiation libraries. Currently there is * support for the following libraries: - * - Adol-C + * - ADOL-C * - Sacado (a component of Trilinos) * * @ingroup auto_symb_diff diff --git a/include/deal.II/differentiation/ad/ad_number_traits.h b/include/deal.II/differentiation/ad/ad_number_traits.h index a85529cc5a..2b5073bb2e 100644 --- a/include/deal.II/differentiation/ad/ad_number_traits.h +++ b/include/deal.II/differentiation/ad/ad_number_traits.h @@ -207,7 +207,7 @@ namespace Differentiation * definition given in @p base/numbers.h , this extension allows the * conversion of automatic-differentiation numbers to generic floats. * - * This is necessary because Adol-C doesn't provide a convenient + * This is necessary because ADOL-C doesn't provide a convenient * way to convert from an @p ADNumberType to floats (@p T) other than * the real-type equivalent that its associated with. For Sacado, and * likely other AD number types, the floating point value stored in @@ -1018,9 +1018,9 @@ namespace Differentiation * AD numbers. * * Sacado nests the directional derivatives within Sacado numbers, while - * Adol-C does not. So, starting off from a scalar function f(x), the number + * ADOL-C does not. So, starting off from a scalar function f(x), the number * type resulting from the computation of a directional derivative f'(x) of - * that function is a floating point number for Adol-C number types and + * that function is a floating point number for ADOL-C number types and * Sacado::FAD, but that of a Sacado::FAD> is a * Sacado::FAD. * @@ -1046,7 +1046,7 @@ namespace Differentiation // If the AD drivers are correctly implemented then we should not get // here. This is essentially a dummy for when the ADNumberTypeCode for // the original AD number (from which one is getting a derivative >= 2) - // is one that specified Adol-C taped and tapeless numbers, or a + // is one that specified ADOL-C taped and tapeless numbers, or a // non-nested Sacado number. AssertThrow( false, diff --git a/include/deal.II/differentiation/ad/ad_number_types.h b/include/deal.II/differentiation/ad/ad_number_types.h index 4747558b35..e199ec25bf 100644 --- a/include/deal.II/differentiation/ad/ad_number_types.h +++ b/include/deal.II/differentiation/ad/ad_number_types.h @@ -29,23 +29,23 @@ namespace Differentiation /** * An enumeration to indicate which type of auto-differentiable number * is to be used for computations. If a type that is selected for use - * is not available in the library, a compile-time error will be thrown. + * is not available in the library, a run-time error will be thrown. * * @author Jean-Paul Pelteret, 2017 */ enum class NumberTypes { /** - * Taped forward and reverse-mode Adol-C number type (n-differentiable). + * Taped forward and reverse-mode ADOL-C number type (n-differentiable). * * First derivatives will be computed using reverse mode, while the second * derivatives will be computed using forward mode. Even higher-order - * derivatives can be computed using Adol-C's own driver functions. + * derivatives can be computed using ADOL-C's own driver functions. */ adolc_taped, /** - * Tapeless dynamic forward-mode Adol-C number type (once differentiable). + * Tapeless dynamic forward-mode ADOL-C number type (once differentiable). */ adolc_tapeless, diff --git a/include/deal.II/differentiation/ad/adolc_math.h b/include/deal.II/differentiation/ad/adolc_math.h index 544fc3d83c..5892e435b6 100644 --- a/include/deal.II/differentiation/ad/adolc_math.h +++ b/include/deal.II/differentiation/ad/adolc_math.h @@ -29,11 +29,11 @@ # ifndef DOXYGEN /** - * Import Adol-C math operations into standard namespace. This gives us the + * Import ADOL-C math operations into standard namespace. This gives us the * ability to use them within the Tensor class, and it also allows the user * to write generic code and switch between AD number types. * - * The math functions to be exposed come from the Adol-C's taped + * The math functions to be exposed come from the ADOL-C's taped * (anonymous) and tapeless namespaces. */ namespace std diff --git a/include/deal.II/differentiation/ad/adolc_number_types.h b/include/deal.II/differentiation/ad/adolc_number_types.h index 87e3169697..f6ab7cbf4e 100644 --- a/include/deal.II/differentiation/ad/adolc_number_types.h +++ b/include/deal.II/differentiation/ad/adolc_number_types.h @@ -29,7 +29,7 @@ namespace Differentiation { /** * A struct to indicate whether a given @p NumberType is an - * Adol-C number or not. By default, numbers are not considered to + * ADOL-C number or not. By default, numbers are not considered to * have the necessary characteristics to fulfill this condition. * * @author Jean-Paul Pelteret, 2017 @@ -41,7 +41,7 @@ namespace Differentiation /** * A struct to indicate whether a given @p NumberType is a taped - * Adol-C number or not. By default, numbers are not considered to + * ADOL-C number or not. By default, numbers are not considered to * have the necessary characteristics to fulfill this condition. * * @author Jean-Paul Pelteret, 2017 @@ -53,7 +53,7 @@ namespace Differentiation /** * A struct to indicate whether a given @p NumberType is a tapeless - * Adol-C number or not. By default, numbers are not considered to + * ADOL-C number or not. By default, numbers are not considered to * have the necessary characteristics to fulfill this condition. * * @author Jean-Paul Pelteret, 2017 @@ -88,12 +88,12 @@ DEAL_II_NAMESPACE_OPEN /** * An exception which states that a function has been disabled due to the - * configuration of Adol-C with the advanced branching feature enabled. + * configuration of ADOL-C with the advanced branching feature enabled. * * @ingroup Exceptions */ DeclExceptionMsg(ExcADOLCAdvancedBranching, - "This function has not yet been implemented for taped Adol-C " + "This function has not yet been implemented for taped ADOL-C " "numbers when the advanced branching feature is activated."); @@ -110,7 +110,7 @@ namespace Differentiation namespace internal { /** - * A specialization for the information struct for taped Adol-C + * A specialization for the information struct for taped ADOL-C * numbers. */ template @@ -129,7 +129,7 @@ namespace Differentiation /** - * A specialization for the information struct for tapeless Adol-C + * A specialization for the information struct for tapeless ADOL-C * numbers. */ template @@ -206,7 +206,7 @@ namespace Differentiation // before defining their directional derivative index out = in; - // Violating this condition when will result in an Adol-C internal + // Violating this condition when will result in an ADOL-C internal // error. We could rather always throw here in order to provide a // less cryptic message. AssertThrow(index < adtl::getNumDir(), @@ -232,7 +232,7 @@ namespace Differentiation /** * A struct to help extract certain information associated with - * taped Adol-C auto-differentiable numbers. + * taped ADOL-C auto-differentiable numbers. * * @author Jean-Paul Pelteret, 2017 */ @@ -274,7 +274,7 @@ namespace Differentiation { AssertThrow(false, ExcMessage( - "The derivative values for taped Adol-C numbers must be" + "The derivative values for taped ADOL-C numbers must be" "computed through the ::gradient function.")); return 0.0; } @@ -283,7 +283,7 @@ namespace Differentiation /** * A struct to help extract certain information associated with - * tapeless Adol-C auto-differentiable numbers. + * tapeless ADOL-C auto-differentiable numbers. * * @author Jean-Paul Pelteret, 2017 */ @@ -322,7 +322,7 @@ namespace Differentiation direction < n_directional_derivatives(x), ExcMessage( "Requested directional derivative is greater than the number " - "registered by Adol-C.")); + "registered by ADOL-C.")); return x.getADValue(direction); } }; @@ -335,7 +335,7 @@ namespace Differentiation * Specialization of the general AdolCWrappers::ADNumberTraits class that * provides relevant information for auto-differentiable numbers. * This specialization is for the case where @p ADNumberType is an - * taped Adol-C (real) double. + * taped ADOL-C (real) double. * * @note In this case the number traits are the same as those for a taped double. * @@ -358,7 +358,7 @@ namespace Differentiation * Specialization of the general ADNumberTraits class that * provides relevant information for auto-differentiable numbers. * This specialization is for the case where @p ADNumberType is an - * taped Adol-C complex double. + * taped ADOL-C complex double. * * @note In this case the number traits are the same as those for a taped complex * double. @@ -383,7 +383,7 @@ namespace Differentiation * Specialization of the general ADNumberTraits class that * provides relevant information for auto-differentiable numbers. * This specialization is for the case where @p ADNumberType is an - * tapeless Adol-C (real) double. + * tapeless ADOL-C (real) double. * * @note In this case the number traits are the same as those for a tapeless double. * @@ -407,7 +407,7 @@ namespace Differentiation * Specialization of the general ADNumberTraits class that * provides relevant information for auto-differentiable numbers. * This specialization is for the case where @p ADNumberType is an - * tapeless Adol-C complex double. + * tapeless ADOL-C complex double. * * @note In this case the number traits are the same as those for a tapeless * complex double. @@ -430,7 +430,7 @@ namespace Differentiation /** * Specialization of the NumberTraits struct for - * the (otherwise disabled) taped Adol-C number type. + * the (otherwise disabled) taped ADOL-C number type. */ template <> struct NumberTraits @@ -441,7 +441,7 @@ namespace Differentiation /** * Specialization of the NumberTraits struct for - * the (otherwise disabled) taped Adol-C complex number type. + * the (otherwise disabled) taped ADOL-C complex number type. */ template <> struct NumberTraits, NumberTypes::adolc_taped> @@ -453,7 +453,7 @@ namespace Differentiation /** * Specialization of the NumberTraits struct for - * the (otherwise disabled) tapeless Adol-C number type. + * the (otherwise disabled) tapeless ADOL-C number type. */ template <> struct NumberTraits @@ -464,7 +464,7 @@ namespace Differentiation /** * Specialization of the NumberTraits struct for - * the (otherwise disabled) tapeless Adol-C complex number type. + * the (otherwise disabled) tapeless ADOL-C complex number type. */ template <> struct NumberTraits, @@ -477,7 +477,7 @@ namespace Differentiation /** * Specialization of the struct for the case when the input template - * parameter is a (real or complex) taped Adol-C number. + * parameter is a (real or complex) taped ADOL-C number. */ template struct is_adolc_taped_number< @@ -490,7 +490,7 @@ namespace Differentiation /** * Specialization of the struct for the case when the input template - * parameter is a (real or complex) tapeless Adol-C number. + * parameter is a (real or complex) tapeless ADOL-C number. */ template struct is_adolc_tapeless_number< @@ -503,7 +503,7 @@ namespace Differentiation /** * Specialization of the struct for the case when the input template - * parameter is a (real or complex; taped or tapeless) Adol-C number. + * parameter is a (real or complex; taped or tapeless) ADOL-C number. */ template struct is_adolc_number @@ -182,7 +182,7 @@ struct EnableIfScalar> }; -/* -- Adol-C tapeless (Differentiation::AD::NumberTypes::adolc_tapeless) -- */ +/* -- ADOL-C tapeless (Differentiation::AD::NumberTypes::adolc_tapeless) -- */ namespace internal diff --git a/source/differentiation/ad/adolc_number_types.cc b/source/differentiation/ad/adolc_number_types.cc index 73dc9270f8..72c3e7b76e 100644 --- a/source/differentiation/ad/adolc_number_types.cc +++ b/source/differentiation/ad/adolc_number_types.cc @@ -35,7 +35,7 @@ namespace numbers namespace { // Apply some comparator and extract the boolean result of the operation, - // instead of the "adub" return type tpyically returned by Adol-C for + // instead of the "adub" return type tpyically returned by ADOL-C for // such a comparison. This is implemented as a general function so that // the list of implemented comparative operations can be easily extended. bool diff --git a/tests/adolc/ad_number_traits_01.cc b/tests/adolc/ad_number_traits_01.cc index d9ef7a1890..182d4f962c 100644 --- a/tests/adolc/ad_number_traits_01.cc +++ b/tests/adolc/ad_number_traits_01.cc @@ -14,7 +14,7 @@ // --------------------------------------------------------------------- -// Test that all of the Adol-C number traits combinations are constructible +// Test that all of the ADOL-C number traits combinations are constructible #include #include diff --git a/tests/adolc/ad_number_traits_02a.cc b/tests/adolc/ad_number_traits_02a.cc index f2378c2345..620467271b 100644 --- a/tests/adolc/ad_number_traits_02a.cc +++ b/tests/adolc/ad_number_traits_02a.cc @@ -14,7 +14,7 @@ // --------------------------------------------------------------------- -// Test that all of the Adol-C number traits return the correct information +// Test that all of the ADOL-C number traits return the correct information // ::adouble (Taped) #include diff --git a/tests/adolc/ad_number_traits_02b.cc b/tests/adolc/ad_number_traits_02b.cc index 88bea95762..cc72104c0a 100644 --- a/tests/adolc/ad_number_traits_02b.cc +++ b/tests/adolc/ad_number_traits_02b.cc @@ -14,7 +14,7 @@ // --------------------------------------------------------------------- -// Test that all of the Adol-C number traits return the correct information +// Test that all of the ADOL-C number traits return the correct information // adtl::adouble (Tapeless) #include diff --git a/tests/adolc/ad_number_traits_03.cc b/tests/adolc/ad_number_traits_03.cc index 34ac8f4419..87494ad020 100644 --- a/tests/adolc/ad_number_traits_03.cc +++ b/tests/adolc/ad_number_traits_03.cc @@ -14,7 +14,7 @@ // --------------------------------------------------------------------- -// Test that all of the Adol-C number traits return the correct information +// Test that all of the ADOL-C number traits return the correct information #include diff --git a/tests/adolc/basic_function_gradient_tapeless.cc b/tests/adolc/basic_function_gradient_tapeless.cc index 4c1f11fd35..0436d0c27c 100644 --- a/tests/adolc/basic_function_gradient_tapeless.cc +++ b/tests/adolc/basic_function_gradient_tapeless.cc @@ -17,7 +17,7 @@ // - Tapeless doubles // - Function and gradient computations // Adapted from -// https://github.com/Homebrew/homebrew-science/blob/master/adol-c.rb See Adol-C +// https://github.com/Homebrew/homebrew-science/blob/master/adol-c.rb See ADOL-C // manual v2.6 p65 figure 8 #include diff --git a/tests/adolc/basic_functions_jacobian_tapeless.cc b/tests/adolc/basic_functions_jacobian_tapeless.cc index 32729894a2..7ef1c85b5e 100644 --- a/tests/adolc/basic_functions_jacobian_tapeless.cc +++ b/tests/adolc/basic_functions_jacobian_tapeless.cc @@ -17,7 +17,7 @@ // - Tapeless doubles // - Multiple dependent functions and Jacobian computations // Adapted from -// https://github.com/Homebrew/homebrew-science/blob/master/adol-c.rb See Adol-C +// https://github.com/Homebrew/homebrew-science/blob/master/adol-c.rb See ADOL-C // manual v2.6 p65 figure 8 #include diff --git a/tests/quick_tests/adolc.cc b/tests/quick_tests/adolc.cc index 51fbab2700..7fa5b9290e 100644 --- a/tests/quick_tests/adolc.cc +++ b/tests/quick_tests/adolc.cc @@ -13,7 +13,7 @@ // // --------------------------------------------------------------------- -// Test of basic functionality for Adol-C: +// Test of basic functionality for ADOL-C: // - Taped doubles // - Gradient and hessian computations // Adapted from