CGAL 5.1 - Geometric Object Generators
CGAL::Random_points_on_square_2< Point_2, Creator > Class Template Reference

#include <CGAL/point_generators_2.h>

Definition

template<typename Point_2, typename Creator>
class CGAL::Random_points_on_square_2< Point_2, Creator >

The class Random_points_on_square_2 is an input iterator creating points uniformly distributed on the boundary of a square.

The default Creator is Creator_uniform_2<Kernel_traits<Point_2>Kernel::RT,Point_2>.

Is Model Of:

InputIterator

PointGenerator

See also
CGAL::Points_on_segment_2<Point_2>
CGAL::Random_points_in_disc_2<Point_2, Creator>
CGAL::Random_points_in_square_2<Point_2, Creator>
CGAL::Random_points_in_triangle_2<Point_2, Creator>
CGAL::Random_points_on_circle_2<Point_2, Creator>
CGAL::Random_points_on_segment_2<Point_2, Creator>

Types

typedef std::input_iterator_tag iterator_category
 
typedef Point_2 value_type
 
typedef std::ptrdiff_t difference_type
 
const typedef Point_2pointer
 
const typedef Point_2reference
 
 Random_points_on_square_2 (double a, Random &rnd=get_default_random())
 creates an input iterator g generating points of type Point_2 uniformly distributed on the boundary of the square with side length \( 2 a\), centered at the origin, i.e. \( \forall p = *g:\) one coordinate is either \( a\) or \( -a\) and for the other coordinate \( c\) holds \( -a \le c < a\). More...
 

Member Typedef Documentation

◆ difference_type

template<typename Point_2 , typename Creator >
typedef std::ptrdiff_t CGAL::Random_points_on_square_2< Point_2, Creator >::difference_type

◆ iterator_category

template<typename Point_2 , typename Creator >
typedef std::input_iterator_tag CGAL::Random_points_on_square_2< Point_2, Creator >::iterator_category

◆ value_type

template<typename Point_2 , typename Creator >
typedef Point_2 CGAL::Random_points_on_square_2< Point_2, Creator >::value_type

Constructor & Destructor Documentation

◆ Random_points_on_square_2()

template<typename Point_2 , typename Creator >
CGAL::Random_points_on_square_2< Point_2, Creator >::Random_points_on_square_2 ( double  a,
Random rnd = get_default_random() 
)

creates an input iterator g generating points of type Point_2 uniformly distributed on the boundary of the square with side length \( 2 a\), centered at the origin, i.e. \( \forall p = *g:\) one coordinate is either \( a\) or \( -a\) and for the other coordinate \( c\) holds \( -a \le c < a\).

A single random number is needed from rnd for each point.

Member Data Documentation

◆ pointer

template<typename Point_2 , typename Creator >
const typedef Point_2* CGAL::Random_points_on_square_2< Point_2, Creator >::pointer

◆ reference

template<typename Point_2 , typename Creator >
const typedef Point_2& CGAL::Random_points_on_square_2< Point_2, Creator >::reference