diff --git a/Algebraic_foundations/doc/Algebraic_foundations/PackageDescription.txt b/Algebraic_foundations/doc/Algebraic_foundations/PackageDescription.txt index ced948ed968..4cd201e04fd 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/PackageDescription.txt +++ b/Algebraic_foundations/doc/Algebraic_foundations/PackageDescription.txt @@ -64,21 +64,21 @@ ### Global Functions ### -- `CGAL::is_zero` -- `CGAL::is_one` -- `CGAL::square` -- `CGAL::simplify` -- `CGAL::unit_part` -- `CGAL::integral_division` -- `CGAL::is_square` -- `CGAL::gcd` -- `CGAL::div_mod` -- `CGAL::div` -- `CGAL::mod` -- `CGAL::inverse` -- `CGAL::sqrt` -- `CGAL::kth_root` -- `CGAL::root_of` +- `CGAL::is_zero()` +- `CGAL::is_one()` +- `CGAL::square()` +- `CGAL::simplify()` +- `CGAL::unit_part()` +- `CGAL::integral_division()` +- `CGAL::is_square()` +- `CGAL::gcd()` +- `CGAL::div_mod()` +- `CGAL::div()` +- `CGAL::mod()` +- `CGAL::inverse()` +- `CGAL::sqrt()` +- `CGAL::kth_root()` +- `CGAL::root_of()` ## Real Embeddable ## @@ -102,14 +102,14 @@ ### Global Functions ### -- `CGAL::is_zero` -- `CGAL::abs` -- `CGAL::sign` -- `CGAL::is_positive` -- `CGAL::is_negative` -- `CGAL::compare` -- `CGAL::to_double` -- `CGAL::to_interval` +- `CGAL::is_zero()` +- `CGAL::abs()` +- `CGAL::sign()` +- `CGAL::is_positive()` +- `CGAL::is_negative()` +- `CGAL::compare()` +- `CGAL::to_double()` +- `CGAL::to_interval()` ## Real Number Types ## diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/PackageDescription.txt b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/PackageDescription.txt index 6eb13f2d754..d0c00029b28 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/PackageDescription.txt +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/PackageDescription.txt @@ -186,19 +186,19 @@ implemented as peripheral classes or as free (global) functions. ## Functions ## -- `CGAL::is_valid` -- `CGAL::insert` -- `CGAL::insert_non_intersecting_curve` -- `CGAL::insert_non_intersecting_curves` -- `CGAL::insert_point` -- `CGAL::remove_edge` -- `CGAL::remove_vertex` -- `CGAL::locate` -- `CGAL::decompose` -- `CGAL::overlay` -- `CGAL::read` -- `CGAL::write` -- `CGAL::remove_curve` +- `CGAL::is_valid()` +- `CGAL::insert()` +- `CGAL::insert_non_intersecting_curve()` +- `CGAL::insert_non_intersecting_curves()` +- `CGAL::insert_point()` +- `CGAL::remove_edge()` +- `CGAL::remove_vertex()` +- `CGAL::locate()` +- `CGAL::decompose()` +- `CGAL::overlay()` +- `CGAL::read()` +- `CGAL::write()` +- `CGAL::remove_curve()` - \link PkgArrangement2op_left_shift `CGAL::operator<<` \endlink - \link PkgArrangement2op_right_shift `CGAL::operator<<` \endlink diff --git a/Convex_hull_2/doc/Convex_hull_2/PackageDescription.txt b/Convex_hull_2/doc/Convex_hull_2/PackageDescription.txt index ec6f7749524..bc2e7d69439 100644 --- a/Convex_hull_2/doc/Convex_hull_2/PackageDescription.txt +++ b/Convex_hull_2/doc/Convex_hull_2/PackageDescription.txt @@ -73,35 +73,35 @@ defining `CGAL_CH_CHECK_EXPENSIVE`. ## Convex Hull Functions ## -- `CGAL::ch_akl_toussaint` -- `CGAL::ch_bykat` -- `CGAL::ch_eddy` -- `CGAL::ch_graham_andrew` -- `CGAL::ch_jarvis` -- `CGAL::ch_melkman` -- `CGAL::convex_hull_2` +- `CGAL::ch_akl_toussaint()` +- `CGAL::ch_bykat()` +- `CGAL::ch_eddy()` +- `CGAL::ch_graham_andrew()` +- `CGAL::ch_jarvis()` +- `CGAL::ch_melkman()` +- `CGAL::convex_hull_2()` ## Convexity Checking Functions ## -- `CGAL::is_ccw_strongly_convex_2` -- `CGAL::is_cw_strongly_convex_2` +- `CGAL::is_ccw_strongly_convex_2()` +- `CGAL::is_cw_strongly_convex_2()` ## Hull Subsequence Functions ## -- `CGAL::ch_graham_andrew_scan` -- `CGAL::ch_jarvis_march` -- `CGAL::lower_hull_points_2` -- `CGAL::upper_hull_points_2` +- `CGAL::ch_graham_andrew_scan()` +- `CGAL::ch_jarvis_march()` +- `CGAL::lower_hull_points_2()` +- `CGAL::upper_hull_points_2()` ## Extreme Point Functions ## -- `CGAL::ch_e_point` -- `CGAL::ch_nswe_point` -- `CGAL::ch_n_point` -- `CGAL::ch_ns_point` -- `CGAL::ch_s_point` -- `CGAL::ch_w_point` -- `CGAL::ch_we_point` +- `CGAL::ch_e_point()` +- `CGAL::ch_nswe_point()` +- `CGAL::ch_n_point()` +- `CGAL::ch_ns_point()` +- `CGAL::ch_s_point()` +- `CGAL::ch_w_point()` +- `CGAL::ch_we_point()` */ diff --git a/Number_types/doc/Number_types/PackageDescription.txt b/Number_types/doc/Number_types/PackageDescription.txt index 0abf0daeece..77a97ce3dc3 100644 --- a/Number_types/doc/Number_types/PackageDescription.txt +++ b/Number_types/doc/Number_types/PackageDescription.txt @@ -93,8 +93,8 @@ ## Relates Rational ## - `CGAL::Rational_traits` -- `CGAL::simplest_rational_in_interval` -- `CGAL::to_rational` +- `CGAL::simplest_rational_in_interval()` +- `CGAL::to_rational()` ## Relates Algebraic Extensions ## @@ -110,9 +110,9 @@ - `CGAL::Min` - `CGAL::Max` - `CGAL::Is_valid` -- `CGAL::min` -- `CGAL::max` -- `CGAL::is_valid` +- `CGAL::min()` +- `CGAL::max()` +- `CGAL::is_valid()` - `CGAL::Set_ieee_double_precision` - `CGAL::Protect_FPU_rounding` diff --git a/Polynomial/doc/Polynomial/PackageDescription.txt b/Polynomial/doc/Polynomial/PackageDescription.txt index 79e0203153a..e032075119e 100644 --- a/Polynomial/doc/Polynomial/PackageDescription.txt +++ b/Polynomial/doc/Polynomial/PackageDescription.txt @@ -102,64 +102,64 @@ ## Functions ## -- `CGAL::get_coefficient` -- `CGAL::get_innermost_coefficient` +- `CGAL::get_coefficient()` +- `CGAL::get_innermost_coefficient()` -- `CGAL::permute` -- `CGAL::swap` -- `CGAL::move` +- `CGAL::permute()` +- `CGAL::swap()` +- `CGAL::move()` -- `CGAL::degree` -- `CGAL::total_degree` -- `CGAL::degree_vector` -- `CGAL::leading_coefficient` -- `CGAL::innermost_leading_coefficient` +- `CGAL::degree()` +- `CGAL::total_degree()` +- `CGAL::degree_vector()` +- `CGAL::leading_coefficient()` +- `CGAL::innermost_leading_coefficient()` -- `CGAL::canonicalize` -- `CGAL::differentiate` +- `CGAL::canonicalize()` +- `CGAL::differentiate()` -- `CGAL::evaluate` -- `CGAL::evaluate_homogeneous` -- `CGAL::substitute` -- `CGAL::substitute_homogeneous` -- `CGAL::is_zero_at` -- `CGAL::is_zero_at_homogeneous` -- `CGAL::sign_at` -- `CGAL::sign_at_homogeneous` +- `CGAL::evaluate()` +- `CGAL::evaluate_homogeneous()` +- `CGAL::substitute()` +- `CGAL::substitute_homogeneous()` +- `CGAL::is_zero_at()` +- `CGAL::is_zero_at_homogeneous()` +- `CGAL::sign_at()` +- `CGAL::sign_at_homogeneous()` -- `CGAL::compare` +- `CGAL::compare()` -- `CGAL::univariate_content` -- `CGAL::multivariate_content` +- `CGAL::univariate_content()` +- `CGAL::multivariate_content()` -- `CGAL::square_free_factorize` -- `CGAL::make_square_free` +- `CGAL::square_free_factorize()` +- `CGAL::make_square_free()` -- `CGAL::pseudo_division` -- `CGAL::pseudo_division_quotient` -- `CGAL::pseudo_division_remainder` +- `CGAL::pseudo_division()` +- `CGAL::pseudo_division_quotient()` +- `CGAL::pseudo_division_remainder()` -- `CGAL::gcd_up_to_constant_factor` -- `CGAL::integral_division_up_to_constant_factor` -- `CGAL::univariate_content_up_to_constant_factor` -- `CGAL::square_free_factorize_up_to_constant_factor` +- `CGAL::gcd_up_to_constant_factor()` +- `CGAL::integral_division_up_to_constant_factor()` +- `CGAL::univariate_content_up_to_constant_factor()` +- `CGAL::square_free_factorize_up_to_constant_factor()` -- `CGAL::shift` -- `CGAL::negate` -- `CGAL::invert` -- `CGAL::translate` -- `CGAL::translate_homogeneous` -- `CGAL::scale` -- `CGAL::scale_homogeneous` +- `CGAL::shift()` +- `CGAL::negate()` +- `CGAL::invert()` +- `CGAL::translate()` +- `CGAL::translate_homogeneous()` +- `CGAL::scale()` +- `CGAL::scale_homogeneous()` -- `CGAL::resultant` -- `CGAL::polynomial_subresultants` -- `CGAL::polynomial_subresultants_with_cofactors` -- `CGAL::principal_subresultants` -- `CGAL::sturm_habicht_sequence` -- `CGAL::sturm_habicht_sequence_with_cofactors` -- `CGAL::principal_sturm_habicht_sequence` -- `CGAL::number_of_real_roots` +- `CGAL::resultant()` +- `CGAL::polynomial_subresultants()` +- `CGAL::polynomial_subresultants_with_cofactors()` +- `CGAL::principal_subresultants()` +- `CGAL::sturm_habicht_sequence()` +- `CGAL::sturm_habicht_sequence_with_cofactors()` +- `CGAL::principal_sturm_habicht_sequence()` +- `CGAL::number_of_real_roots()` */ diff --git a/QP_solver/doc/QP_solver/PackageDescription.txt b/QP_solver/doc/QP_solver/PackageDescription.txt index 4b71e16143a..2121afe4bba 100644 --- a/QP_solver/doc/QP_solver/PackageDescription.txt +++ b/QP_solver/doc/QP_solver/PackageDescription.txt @@ -45,17 +45,17 @@ This module provides makers to construct a program, as well as functions to solv In case you want to construct a program from complicated iterators (whose types you don't know, or simply don't want to bother with), we provide four makers. -- `CGAL::make_quadratic_program_from_iterators` -- `CGAL::make_linear_program_from_iterators` -- `CGAL::make_nonnegative_quadratic_program_from_iterators` -- `CGAL::make_nonnegative_linear_program_from_iterators`. +- `CGAL::make_quadratic_program_from_iterators()` +- `CGAL::make_linear_program_from_iterators()` +- `CGAL::make_nonnegative_quadratic_program_from_iterators()` +- `CGAL::make_nonnegative_linear_program_from_iterators()` There are four functions to solve a program, one for each program concept. -- `CGAL::solve_quadratic_program` -- `CGAL::solve_linear_program` -- `CGAL::solve_nonnegative_quadratic_program` -- `CGAL::solve_nonnegative_linear_program` +- `CGAL::solve_quadratic_program()` +- `CGAL::solve_linear_program()` +- `CGAL::solve_nonnegative_quadratic_program()` +- `CGAL::solve_nonnegative_linear_program()` The solution process can customized by passing an object of the class @@ -63,10 +63,10 @@ The solution process can customized by passing an object of the class Programs can be written to an output stream in MPSFormat, using one of the following four functions. -- `CGAL::print_quadratic_program` -- `CGAL::print_linear_program` -- `CGAL::print_nonnegative_quadratic_program` -- `CGAL::print_nonnegative_linear_program` +- `CGAL::print_quadratic_program()` +- `CGAL::print_linear_program()` +- `CGAL::print_nonnegative_quadratic_program()` +- `CGAL::print_nonnegative_linear_program()` */ @@ -128,17 +128,17 @@ In case you want to construct a program from complicated iterators (whose types you don't know, or simply don't want to bother with), we provide four makers. -- `CGAL::make_quadratic_program_from_iterators` -- `CGAL::make_linear_program_from_iterators` -- `CGAL::make_nonnegative_quadratic_program_from_iterators` -- `CGAL::make_nonnegative_linear_program_from_iterators` +- `CGAL::make_quadratic_program_from_iterators()` +- `CGAL::make_linear_program_from_iterators()` +- `CGAL::make_nonnegative_quadratic_program_from_iterators()` +- `CGAL::make_nonnegative_linear_program_from_iterators()` There are four functions to solve a program, one for each program concept: -- `CGAL::solve_quadratic_program` -- `CGAL::solve_linear_program` -- `CGAL::solve_nonnegative_quadratic_program` -- `CGAL::solve_nonnegative_linear_program` +- `CGAL::solve_quadratic_program()` +- `CGAL::solve_linear_program()` +- `CGAL::solve_nonnegative_quadratic_program()` +- `CGAL::solve_nonnegative_linear_program()` The solution process can customized by passing an object of the class @@ -147,10 +147,10 @@ The solution process can customized by passing an object of the class Programs can be written to an output stream in MPSFormat, using one of the following four functions: -- `CGAL::print_quadratic_program` -- `CGAL::print_linear_program` -- `CGAL::print_nonnegative_quadratic_program` -- `CGAL::print_nonnegative_linear_program` +- `CGAL::print_quadratic_program()` +- `CGAL::print_linear_program()` +- `CGAL::print_nonnegative_quadratic_program()` +- `CGAL::print_nonnegative_linear_program()` */