CGAL::Random_points_on_segment_3< Point_3, Creator > Class Template Reference

#include <CGAL/point_generators_3.h>

Definition

template<typename Point_3, typename Creator>
class CGAL::Random_points_on_segment_3< Point_3, Creator >

The class Random_points_on_segment_3 is an input iterator creating points uniformly distributed on a segment.

The default Creator is Creator_uniform_3<Kernel_traits<Point_3>Kernel::RT,Point_3>.

Is Model Of:

InputIterator

PointGenerator

See also

CGAL::Random_points_in_cube_3<Point_3, Creator>

CGAL::Random_points_in_triangle_3<Point_3, Creator>

CGAL::Random_points_on_sphere_3<Point_3, Creator>

CGAL::Random_points_in_tetrahedron_3<Point_3, Creator>

Types
typedef std::input_iterator_tag	iterator_category
typedef Point_3	value_type
typedef std::ptrdiff_t	difference_type
const typedef Point_3 *	pointer
const typedef Point_3 &	reference
	Random_points_on_segment_3 (const Point_3 &p, const Point_3 &q, Random &rnd=get_default_random())
	creates an input iterator g generating points of type Point_3 uniformly distributed on the segment from \( p\) to \( q\) (excluding \( q\)), i.e. \( *g == (1-\lambda)\, p + \lambda q\) where \( 0 \le\lambda< 1\). More...

Member Typedef Documentation

difference_type

template<typename Point_3 , typename Creator >

typedef std::ptrdiff_t CGAL::Random_points_on_segment_3< Point_3, Creator >::difference_type

iterator_category

template<typename Point_3 , typename Creator >

typedef std::input_iterator_tag CGAL::Random_points_on_segment_3< Point_3, Creator >::iterator_category

value_type

template<typename Point_3 , typename Creator >

typedef Point_3 CGAL::Random_points_on_segment_3< Point_3, Creator >::value_type

Constructor & Destructor Documentation

Random_points_on_segment_3()

template<typename Point_3 , typename Creator >

CGAL::Random_points_on_segment_3< Point_3, Creator >::Random_points_on_segment_3	(	const Point_3 &	p,
		const Point_3 &	q,
		Random &	rnd = get_default_random()
	)

creates an input iterator g generating points of type Point_3 uniformly distributed on the segment from \( p\) to \( q\) (excluding \( q\)), i.e. \( *g == (1-\lambda)\, p + \lambda q\) where \( 0 \le\lambda< 1\).

A single random number is needed from rnd for each point. The expressions to_double(p.x()), to_double(p.y()), and to_double(p.z()) must result in the respective double representation of the coordinates of \( p\), and similarly for \( q\).

Member Data Documentation

pointer

template<typename Point_3 , typename Creator >

const typedef Point_3* CGAL::Random_points_on_segment_3< Point_3, Creator >::pointer

reference

template<typename Point_3 , typename Creator >

const typedef Point_3& CGAL::Random_points_on_segment_3< Point_3, Creator >::reference