Predicates

Functions
template<class PointRange , class NamedParameters_1 = parameters::Default_named_parameters, class NamedParameters_2 = parameters::Default_named_parameters>
bool	CGAL::Convex_hull_3::do_intersect (const PointRange &r1, const PointRange &r2, const NamedParameters_1 &np1=parameters::default_values(), const NamedParameters_2 &np2=parameters::default_values())
	indicates if the convex hull of point sets provide intersect or not.
template<class AdjacencyGraph , class NamedParameters_1 = parameters::Default_named_parameters, class NamedParameters_2 = parameters::Default_named_parameters>
bool	CGAL::Convex_hull_3::do_intersect (const AdjacencyGraph &g1, const AdjacencyGraph &g2, const NamedParameters_1 &np1=parameters::default_values(), const NamedParameters_2 &np2=parameters::default_values())
	indicates if the convex graph provide intersect or not.
template<class PolygonMesh , class NamedParameters_1 = parameters::Default_named_parameters, class NamedParameters_2 = parameters::Default_named_parameters>
bool	CGAL::Convex_hull_3::do_intersect (const Convex_hull_hierarchy< PolygonMesh > &ch1, const Convex_hull_hierarchy< PolygonMesh > &ch2, const NamedParameters_1 &np1=parameters::default_values(), const NamedParameters_2 &np2=parameters::default_values())
	indicates if the convex hulls provide intersect or not.
template<class Graph , class Direction_3 , class NamedParameters >
Point_3	CGAL::Convex_hull_3::extreme_point (const Graph &g, const Direction_3 &dir, const NamedParameters &np)
	computes the furthest point of the convex graph along the direction.
template<class PointRange , class Direction_3 , class NamedParameters >
Point_3	CGAL::Convex_hull_3::extreme_point (const PointRange &r, const Direction_3 &dir, const NamedParameters &np)
	computes the furthest point of the range along the direction.
template<class PolygonMesh , class Direction_3 , class NamedParameters >
Point_3	CGAL::Convex_hull_3::extreme_point (const Convex_hull_hierarchy< PolygonMesh > &ch, const Direction_3 &dir, const NamedParameters &np)
	computes the furthest point of the convex hull along the direction.
template<class PointRange , class NamedParameters_1 = parameters::Default_named_parameters, class NamedParameters_2 = parameters::Default_named_parameters>
FT	CGAL::Convex_hull_3::separation_distance (const PointRange &r1, const PointRange &r2, const NamedParameters_1 &np1=parameters::default_values(), const NamedParameters_2 &np2=parameters::default_values())
	provides a lower bound on the distance between the two convex hull of point sets provide.
template<class AdjacencyGraph , class NamedParameters_1 = parameters::Default_named_parameters, class NamedParameters_2 = parameters::Default_named_parameters>
FT	CGAL::Convex_hull_3::separation_distance (const AdjacencyGraph &g1, const AdjacencyGraph &g2, const NamedParameters_1 &np1=parameters::default_values(), const NamedParameters_2 &np2=parameters::default_values())
	provides a lower bound on the distance between the two convex graph.
template<class PolygonMesh , class NamedParameters_1 = parameters::Default_named_parameters, class NamedParameters_2 = parameters::Default_named_parameters>
FT	CGAL::Convex_hull_3::separation_distance (const Convex_hull_hierarchy< PolygonMesh > &ch1, const Convex_hull_hierarchy< PolygonMesh > &ch2, const NamedParameters_1 &np1=parameters::default_values(), const NamedParameters_2 &np2=parameters::default_values())
	provides a lower bound on the distance between the two convex hulls.

Function Documentation

do_intersect() [1/3]

template<class AdjacencyGraph , class NamedParameters_1 = parameters::Default_named_parameters, class NamedParameters_2 = parameters::Default_named_parameters>

bool CGAL::Convex_hull_3::do_intersect	(	const AdjacencyGraph &	g1,
		const AdjacencyGraph &	g2,
		const NamedParameters_1 &	np1 = parameters::default_values(),
		const NamedParameters_2 &	np2 = parameters::default_values()
	)

#include <CGAL/Convex_hull_3/predicates.h>

indicates if the convex graph provide intersect or not.

Template Parameters

AdjacencyGraph	is a model of AdjacencyGraph.
NamedParameters_1	a sequence of Named Parameters
NamedParameters_2	a sequence of Named Parameters

Parameters

g1	the first convex graph considered in the do-intersect test
g2	the second convex graph considered in the do-intersect test
np1	an optional sequence of Named Parameters among the ones listed below
np2	an optional sequence of Named Parameters among the ones listed below

Optional Named Parameters

vertex_point_map a property map associating points to the vertices of g1 (g2) Type: a model of ReadablePropertyMap whose value types are the same for np1 and np2 Default: boost::get(CGAL::vertex_point, g) Extra: If this parameter is omitted, an internal property map for CGAL::vertex_point_t must be available in IncidentGraph.
geom_traits An instance of a geometric traits class Type: a class model of Kernel Default: a CGAL Kernel deduced from the point type, using CGAL::Kernel_traits Extra: np1 only
number_of_iterations if not 0 (no limit), indicates the maximum number of iterations that the algorithm is allowed to do. If this value is not 0, then an intersection might be reported even if the convex hulls does not intersect. However, if the convex hulls are reported not to intersect, this is guaranteed. Type: an positive integer convertible to std::size_t Extra: np1 only Default: 0

do_intersect() [2/3]

template<class PolygonMesh , class NamedParameters_1 = parameters::Default_named_parameters, class NamedParameters_2 = parameters::Default_named_parameters>

bool CGAL::Convex_hull_3::do_intersect	(	const Convex_hull_hierarchy< PolygonMesh > &	ch1,
		const Convex_hull_hierarchy< PolygonMesh > &	ch2,
		const NamedParameters_1 &	np1 = parameters::default_values(),
		const NamedParameters_2 &	np2 = parameters::default_values()
	)

#include <CGAL/Convex_hull_3/predicates.h>

indicates if the convex hulls provide intersect or not.

Template Parameters

PolygonMesh	is a model of MutableFaceGraph, more details in CGAL::Convex_hull_hierarchy
NamedParameters_1	a sequence of Named Parameters
NamedParameters_2	a sequence of Named Parameters

Parameters

ch1	the first hull convex considered in the do-intersect test
ch2	the second hull convex considered in the do-intersect test
np1	an optional sequence of Named Parameters among the ones listed below
np2	an optional sequence of Named Parameters among the ones listed below

Optional Named Parameters

vertex_point_map a property map associating points to the vertices of ch1 (ch2) Type: a model of ReadablePropertyMap whose value types are the same for np1 and np2 Default: boost::get(CGAL::vertex_point, g) Extra: If this parameter is omitted, an internal property map for CGAL::vertex_point_t must be available in IncidentGraph.
geom_traits An instance of a geometric traits class Type: a class model of Kernel Default: a CGAL Kernel deduced from the point type, using CGAL::Kernel_traits Extra: np1 only
number_of_iterations if not 0 (no limit), indicates the maximum number of iterations that the algorithm is allowed to do. If this value is not 0, then an intersection might be reported even if the convex hulls does not intersect. However, if the convex hulls are reported not to intersect, this is guaranteed. Type: an positive integer convertible to std::size_t Extra: np1 only Default: 0

do_intersect() [3/3]

template<class PointRange , class NamedParameters_1 = parameters::Default_named_parameters, class NamedParameters_2 = parameters::Default_named_parameters>

bool CGAL::Convex_hull_3::do_intersect	(	const PointRange &	r1,
		const PointRange &	r2,
		const NamedParameters_1 &	np1 = parameters::default_values(),
		const NamedParameters_2 &	np2 = parameters::default_values()
	)

#include <CGAL/Convex_hull_3/predicates.h>

indicates if the convex hull of point sets provide intersect or not.

Template Parameters

PointRange	is a model of ConstRange. The value type of its iterator is the key type of the named parameter point_map.
NamedParameters_1	a sequence of Named Parameters
NamedParameters_2	a sequence of Named Parameters

Parameters

r1	range points of the first convex considered in the do-intersect test
r2	range points of the second convex considered in the do-intersect test
np1	an optional sequence of Named Parameters among the ones listed below
np2	an optional sequence of Named Parameters among the ones listed below

Optional Named Parameters

point_map a property map associating points to the elements of r1 (r2) Type: a model of ReadablePropertyMap whose value types are the same for np1 and np2 Default: CGAL::Identity_property_map
geom_traits An instance of a geometric traits class Type: a class model of Kernel Default: a CGAL Kernel deduced from the point type, using CGAL::Kernel_traits Extra: np1 only
number_of_iterations if not 0 (no limit), indicates the maximum number of iterations that the algorithm is allowed to do. If this value is not 0, then an intersection might be reported even if the convex hulls does not intersect. However, if the convex hulls are reported not to intersect, this is guaranteed. Type: an positive integer convertible to std::size_t Extra: np1 only Default: 0

Examples

Convex_hull_3/do_intersect_ch3.cpp.

extreme_point() [1/3]

template<class PolygonMesh , class Direction_3 , class NamedParameters >

Point_3 CGAL::Convex_hull_3::extreme_point	(	const Convex_hull_hierarchy< PolygonMesh > &	ch,
		const Direction_3 &	dir,
		const NamedParameters &	np
	)

#include <CGAL/Convex_hull_3/predicates.h>

computes the furthest point of the convex hull along the direction.

Template Parameters

PolygonMesh	is a model of MutableFaceGraph, more details in CGAL::Convex_hull_hierarchy
Direction_3	is a model of CGAL::Direction_3.
NamedParameters	a sequence of Named Parameters

Parameters

ch	the convex hull
dir	the direction
np	an optional sequence of Named Parameters among the ones listed below

Optional Named Parameters

vertex_point_map a property map associating points to the vertices of chg Type: a model of ReadablePropertyMap Default: boost::get(CGAL::vertex_point, ch) Extra: If this parameter is omitted, an internal property map for CGAL::vertex_point_t must be available in AdjacencyGraph.
geom_traits An instance of a geometric traits class Type: a class model of Kernel Default: a CGAL Kernel deduced from Direction_3, using CGAL::Kernel_traits
geom_traits_converter A Converter from the point type of vertex_point_map to the point type of geom_traits Type: a class model of NT_Converter Default: a CGAL Cartesian_converter deduced from vertex_point_map and geom_traits, using CGAL::Kernel_traits

extreme_point() [2/3]

template<class Graph , class Direction_3 , class NamedParameters >

Point_3 CGAL::Convex_hull_3::extreme_point	(	const Graph &	g,
		const Direction_3 &	dir,
		const NamedParameters &	np
	)

#include <CGAL/Convex_hull_3/predicates.h>

computes the furthest point of the convex graph along the direction.

Template Parameters

Graph	is a model of AdjacencyGraph.
Direction_3	is a model of CGAL::Direction_3.
NamedParameters	a sequence of Named Parameters

Parameters

g	the convex graph
dir	the direction
np	an optional sequence of Named Parameters among the ones listed below

Optional Named Parameters

vertex_point_map a property map associating points to the vertices of g Type: a model of ReadablePropertyMap Default: boost::get(CGAL::vertex_point, g) Extra: If this parameter is omitted, an internal property map for CGAL::vertex_point_t must be available in AdjacencyGraph.
geom_traits An instance of a geometric traits class Type: a class model of Kernel Default: a CGAL Kernel deduced from Direction_3, using CGAL::Kernel_traits
geom_traits_converter A Converter from the point type of vertex_point_map to the point type of geom_traits Type: a class model of NT_Converter Default: a CGAL Cartesian_converter deduced from vertex_point_map and geom_traits, using CGAL::Kernel_traits

extreme_point() [3/3]

template<class PointRange , class Direction_3 , class NamedParameters >

Point_3 CGAL::Convex_hull_3::extreme_point	(	const PointRange &	r,
		const Direction_3 &	dir,
		const NamedParameters &	np
	)

#include <CGAL/Convex_hull_3/predicates.h>

computes the furthest point of the range along the direction.

Template Parameters

PointRange	is a model of ConstRange. The value type of its iterator is the key type of the named parameter point_map.
Direction_3	is a model of CGAL::Direction_3.
NamedParameters	a sequence of Named Parameters

Parameters

r	the range of points
dir	the direction
np	an optional sequence of Named Parameters among the ones listed below

Optional Named Parameters

point_map a property map associating points to the elements of r Type: a model of ReadablePropertyMap whose value types are the same for np1 and np2 Default: CGAL::Identity_property_map
geom_traits An instance of a geometric traits class Type: a class model of Kernel Default: a CGAL Kernel deduced from Direction_3, using CGAL::Kernel_traits
geom_traits_converter A Converter from the point type of vertex_point_map to the point type of geom_traits Type: a class model of NT_Converter Default: a CGAL Cartesian_converter deduced from point_map and geom_traits, using CGAL::Kernel_traits

separation_distance() [1/3]

template<class AdjacencyGraph , class NamedParameters_1 = parameters::Default_named_parameters, class NamedParameters_2 = parameters::Default_named_parameters>

FT CGAL::Convex_hull_3::separation_distance	(	const AdjacencyGraph &	g1,
		const AdjacencyGraph &	g2,
		const NamedParameters_1 &	np1 = parameters::default_values(),
		const NamedParameters_2 &	np2 = parameters::default_values()
	)

#include <CGAL/Convex_hull_3/predicates.h>

provides a lower bound on the distance between the two convex graph.

Template Parameters

AdjacencyGraph	is a model of AdjacencyGraph.
NamedParameters_1	a sequence of Named Parameters
NamedParameters_2	a sequence of Named Parameters

Parameters

g1	the first convex graph considered in the do-intersect test
g2	the second convex graph considered in the do-intersect test
np1	an optional sequence of Named Parameters among the ones listed below
np2	an optional sequence of Named Parameters among the ones listed below

Optional Named Parameters

vertex_point_map a property map associating points to the vertices of g1 (g2) Type: a model of ReadablePropertyMap whose value types are the same for np1 and np2 Default: boost::get(CGAL::vertex_point, g) Extra: If this parameter is omitted, an internal property map for CGAL::vertex_point_t must be available in IncidentGraph.
geom_traits An instance of a geometric traits class Type: a class model of Kernel Default: a CGAL Kernel deduced from the point type, using CGAL::Kernel_traits Extra: np1 only
number_of_iterations if not 0 (no limit), indicates the maximum number of iterations that the algorithm is allowed to do. If this value is not 0, then an intersection might be reported even if the convex hulls does not intersect. However, if the convex hulls are reported not to intersect, this is guaranteed. Type: an positive integer convertible to std::size_t Extra: np1 only Default: 0

separation_distance() [2/3]

template<class PolygonMesh , class NamedParameters_1 = parameters::Default_named_parameters, class NamedParameters_2 = parameters::Default_named_parameters>

FT CGAL::Convex_hull_3::separation_distance	(	const Convex_hull_hierarchy< PolygonMesh > &	ch1,
		const Convex_hull_hierarchy< PolygonMesh > &	ch2,
		const NamedParameters_1 &	np1 = parameters::default_values(),
		const NamedParameters_2 &	np2 = parameters::default_values()
	)

#include <CGAL/Convex_hull_3/predicates.h>

provides a lower bound on the distance between the two convex hulls.

Template Parameters

PolygonMesh	is a model of MutableFaceGraph, more details in CGAL::Convex_hull_hierarchy
NamedParameters_1	a sequence of Named Parameters
NamedParameters_2	a sequence of Named Parameters

Parameters

ch1	the first hull convex considered in the do-intersect test
ch2	the second hull convex considered in the do-intersect test
np1	an optional sequence of Named Parameters among the ones listed below
np2	an optional sequence of Named Parameters among the ones listed below

Optional Named Parameters

vertex_point_map a property map associating points to the vertices of ch1 (ch2) Type: a model of ReadablePropertyMap whose value types are the same for np1 and np2 Default: boost::get(CGAL::vertex_point, g) Extra: If this parameter is omitted, an internal property map for CGAL::vertex_point_t must be available in IncidentGraph.
geom_traits An instance of a geometric traits class Type: a class model of Kernel Default: a CGAL Kernel deduced from the point type, using CGAL::Kernel_traits Extra: np1 only
number_of_iterations if not 0 (no limit), indicates the maximum number of iterations that the algorithm is allowed to do. If this value is not 0, then an intersection might be reported even if the convex hulls does not intersect. However, if the convex hulls are reported not to intersect, this is guaranteed. Type: an positive integer convertible to std::size_t Extra: np1 only Default: 0

separation_distance() [3/3]

template<class PointRange , class NamedParameters_1 = parameters::Default_named_parameters, class NamedParameters_2 = parameters::Default_named_parameters>

FT CGAL::Convex_hull_3::separation_distance	(	const PointRange &	r1,
		const PointRange &	r2,
		const NamedParameters_1 &	np1 = parameters::default_values(),
		const NamedParameters_2 &	np2 = parameters::default_values()
	)

#include <CGAL/Convex_hull_3/predicates.h>

provides a lower bound on the distance between the two convex hull of point sets provide.

Template Parameters

PointRange	is a model of ConstRange. The value type of its iterator is the key type of the named parameter point_map.
NamedParameters_1	a sequence of Named Parameters
NamedParameters_2	a sequence of Named Parameters

Parameters

r1	range points of the first convex considered in the do-intersect test
r2	range points of the second convex considered in the do-intersect test
np1	an optional sequence of Named Parameters among the ones listed below
np2	an optional sequence of Named Parameters among the ones listed below

Optional Named Parameters

point_map a property map associating points to the elements of r1 (r2) Type: a model of ReadablePropertyMap whose value types are the same for np1 and np2 Default: CGAL::Identity_property_map
geom_traits An instance of a geometric traits class Type: a class model of Kernel Default: a CGAL Kernel deduced from the point type, using CGAL::Kernel_traits Extra: np1 only
number_of_iterations if not 0 (no limit), indicates the maximum number of iterations that the algorithm is allowed to do. If this value is not 0, then an intersection might be reported even if the convex hulls does not intersect. However, if the convex hulls are reported not to intersect, this is guaranteed. Type: an positive integer convertible to std::size_t Extra: np1 only Default: 0