#include <AbstractBoundingSphericalShell.h>

Inheritance diagram for AbstractBoundingSphericalShell:

[legend]

Collaboration diagram for AbstractBoundingSphericalShell:

Public Member Functions
Construction
	AbstractBoundingSphericalShell (const size_t _n, const double _outer=std::numeric_limits< double >::max(), const double _inner=0)

	AbstractBoundingSphericalShell (const std::vector< double > &_center, const double _outer=std::numeric_limits< double >::max(), const double _inner=0)

	AbstractBoundingSphericalShell (XMLNode &_node)

virtual	~AbstractBoundingSphericalShell () noexcept

Boundary Properties
virtual size_t	GetDimension () const noexcept override
	Get the dimension of this boundary. More...

virtual double	GetMaxDist (const double _r1=2.0, const double _r2=0.5) const override

virtual const Range< double > &	GetRange (const size_t _i) const override

virtual const std::vector< double > &	GetCenter () const noexcept override
	Get the boundary's center point. More...

virtual double	GetVolume () const noexcept override
	Get the boundary's volume (Lebesgue Measure). More...

Sampling
virtual std::vector< double >	GetRandomPoint () const override
	Get a random point inside the boundary. More...

virtual void	PushInside (std::vector< double > &_sample) const noexcept override

Containment Testing
virtual bool	InBoundary (const std::vector< double > &_p) const override

virtual bool	InBoundary (const Vector3d &_p) const

virtual bool	InBoundary (const std::vector< double > &_v) const=0

virtual bool	InBoundary (const Cfg &_c) const=0

Clearance Testing
virtual double	GetClearance (const Vector3d &_p) const override

virtual Vector3d	GetClearancePoint (const Vector3d &_p) const override

Modifiers
virtual void	SetCenter (const std::vector< double > &_c) noexcept override

virtual void	Translate (const Vector3d &_v) override

virtual void	Translate (const std::vector< double > &_t) override

virtual void	ResetBoundary (const std::vector< std::pair< double, double >> &_bbx, const double _margin) override

I/O
virtual void	Read (std::istream &_is, CountingStreamBuffer &_cbs) override

virtual void	Write (std::ostream &_os) const override

Public Member Functions inherited from Boundary
virtual Space	Type () const noexcept=0
	Get the space type. More...

virtual std::string	Name () const noexcept=0
	Get the name of the boundary type. More...

virtual void	ScalePoint (std::vector< double > &_point) const noexcept

virtual void	UnscalePoint (std::vector< double > &_point) const noexcept

virtual bool	InBoundary (const Vector3d &_p) const

virtual bool	InBoundary (const Cfg &_c) const =0

virtual CGALPolyhedron	CGAL () const
	Create a CGAL polyhedron representation of this. More...

virtual GMSPolyhedron	MakePolyhedron () const

virtual	~Boundary () noexcept

virtual std::unique_ptr< Boundary >	Clone () const =0

Public Member Functions inherited from NSphericalShell
	NSphericalShell (const size_t _n, const double _outer=std::numeric_limits< double >::max(), const double _inner=0)

	NSphericalShell (const std::vector< double > &_center, const double _outer=std::numeric_limits< double >::max(), const double _inner=0)

virtual	~NSphericalShell () noexcept

size_t	GetDimension () const noexcept
	Get the dimension of this sphere. More...

void	SetCenter (const std::vector< double > &_c) noexcept

const std::vector< double > &	GetCenter () const noexcept
	Get the center point. More...

double	GetOuterRadius () const noexcept
	Get the outer radius. More...

double	GetInnerRadius () const noexcept
	Get the inner radius. More...

void	SetOuterRadius (const double _r) noexcept
	Set the outer radius. More...

void	SetInnerRadius (const double _r) noexcept
	Set the inner radius. More...

void	Translate (const std::vector< double > &_v) noexcept

double	GetVolume () const noexcept
	Compute the (hyper)volume or Lebesgue measure. More...

bool	Contains (const std::vector< double > &_p) const noexcept

double	Clearance (std::vector< double > _p) const noexcept

std::vector< double >	ClearancePoint (std::vector< double > _p) const noexcept

std::vector< double >	Sample () const

Additional Inherited Members
Public Types inherited from Boundary
enum	Space { Workspace , CSpace }
	The types of space that can be modeled with boundaries. More...

typedef CGAL::Exact_predicates_exact_constructions_kernel	CGALKernel

typedef CGAL::Polyhedron_3< CGALKernel >	CGALPolyhedron

Static Public Member Functions inherited from Boundary
static std::unique_ptr< Boundary >	Factory (XMLNode &_node)

Protected Member Functions inherited from Boundary
bool	InWorkspace (const Cfg &_c) const

bool	InCSpace (const Cfg &_c) const

Detailed Description

An n-dimensional bounding spherical shell.

Constructor & Destructor Documentation

◆ AbstractBoundingSphericalShell() [1/3]

AbstractBoundingSphericalShell::AbstractBoundingSphericalShell	(	const size_t	_n,
		const double	_outer = `std::numeric_limits<double>::max()`,
		const double	_inner = `0`
	)

explicit

Construct a bounding spherical shell at the origin with a fixed number of dimensions and radius.

Parameters

_n	The number of dimensions to use.
_outer	The outer radius (infinite by default).
_inner	The inner radius (0 by default).

◆ AbstractBoundingSphericalShell() [2/3]

AbstractBoundingSphericalShell::AbstractBoundingSphericalShell	(	const std::vector< double > &	_center,
		const double	_outer = `std::numeric_limits<double>::max()`,
		const double	_inner = `0`
	)

explicit

Construct a bounding spherical shell with a given center point and radius.

Parameters

_center	The center point, which is assumed to be of full dimension.
_outer	The outer radius (infinite by default).
_inner	The inner radius (0 by default).

◆ AbstractBoundingSphericalShell() [3/3]

AbstractBoundingSphericalShell::AbstractBoundingSphericalShell ( XMLNode & _node )

Construct a bounding spherical shell from an XML node.

Parameters

_node The XML node to parse.

◆ ~AbstractBoundingSphericalShell()

AbstractBoundingSphericalShell::~AbstractBoundingSphericalShell ( )

virtualdefaultnoexcept

Member Function Documentation

◆ GetCenter()

const std::vector< double > & AbstractBoundingSphericalShell::GetCenter ( ) const

overridevirtualnoexcept

Get the boundary's center point.

Implements Boundary.

◆ GetClearance()

double AbstractBoundingSphericalShell::GetClearance ( const Vector3d & _p ) const

overridevirtual

Get the distance from a test point to the nearest point on the boundary.

Parameters

_p	The test point.

Returns: The distance from _p to the clearance point of _p.

Implements Boundary.

◆ GetClearancePoint()

Vector3d AbstractBoundingSphericalShell::GetClearancePoint ( const Vector3d & _p ) const

overridevirtual

Get the nearest point on the boundary to a test point.

Parameters

_p	The test point.

Returns: The point on this boundary nearest to _p.

Implements Boundary.

◆ GetDimension()

size_t AbstractBoundingSphericalShell::GetDimension ( ) const

overridevirtualnoexcept

Get the dimension of this boundary.

Implements Boundary.

◆ GetMaxDist()

double AbstractBoundingSphericalShell::GetMaxDist	(	const double	_r1 = `2.0`,
		const double	_r2 = `0.5`
	)		const

overridevirtual

Get the longest distance contained within the boundary. Supports any Minkowski distance.

Parameters

_r1	The term-wise power in the Minkowski difference.
_r2	The whole expression power in the Minkowski difference.

Implements Boundary.

◆ GetRandomPoint()

std::vector< double > AbstractBoundingSphericalShell::GetRandomPoint ( ) const

overridevirtual

Get a random point inside the boundary.

Implements Boundary.

◆ GetRange()

const Range< double > & AbstractBoundingSphericalShell::GetRange ( const size_t _i ) const

overridevirtual

Get the boundary range for a specific dimension.

Parameters

_i	The dimension index.

Returns: The range of values spanned by this boundary in dimension _i.

Implements Boundary.

◆ GetVolume()

double AbstractBoundingSphericalShell::GetVolume ( ) const

overridevirtualnoexcept

Get the boundary's volume (Lebesgue Measure).

Implements Boundary.

◆ InBoundary() [1/4]

virtual bool Boundary::InBoundary

Test if a configuration lies within the boundary.

Parameters

_cfg	The configuration to test.

Returns: True if the configuration is considered to lie inside the boundary.

◆ InBoundary() [2/4]

bool AbstractBoundingSphericalShell::InBoundary ( const std::vector< double > & _v ) const

overridevirtual

Test if a specific n-dimensional point lies within the boundary.

Parameters

_v	The point to test.

Returns: True if _v lies inside this boundary.

Implements Boundary.

◆ InBoundary() [3/4]

virtual bool Boundary::InBoundary

Test if a specific n-dimensional point lies within the boundary.

Parameters

_v	The point to test.

Returns: True if _v lies inside this boundary.

◆ InBoundary() [4/4]

bool Boundary::InBoundary

Test if a specific point lies within the boundary.

Parameters

_p	The point to test.

Returns: True if _p lies inside this boundary.

◆ PushInside()

void AbstractBoundingSphericalShell::PushInside ( std::vector< double > & _point ) const

overridevirtualnoexcept

Minimally push a point so that it lies within the boundary.

Parameters

_point The point to push.

Implements Boundary.

◆ Read()

void AbstractBoundingSphericalShell::Read	(	std::istream &	_is,
		CountingStreamBuffer &	_cbs
	)

overridevirtual

Read in a boundary.

Parameters

_is	The input stream to read from.
_cbs	The counting stream buffer for keeping track of where we are in the input stream.

Implements Boundary.

◆ ResetBoundary()

void AbstractBoundingSphericalShell::ResetBoundary	(	const std::vector< std::pair< double, double >> &	_bbx,
		const double	_margin
	)

overridevirtual

Resize the boundary to fit inside a bounding box plus some margin.

Parameters

_bbx	The new base bounding box.
_margin	The additional margin for _bbx. Negative margins cause shrinkage.

Implements Boundary.

◆ SetCenter()

void AbstractBoundingSphericalShell::SetCenter ( const std::vector< double > & _c )

overridevirtualnoexcept

Move the boundary to a new center point.

Parameters

_c	The new center point for the boundary.

Implements Boundary.

◆ Translate() [1/2]

void AbstractBoundingSphericalShell::Translate ( const std::vector< double > & _t )

overridevirtual

Translate the boundary.

Parameters

_t	The offset to apply.

Implements Boundary.

◆ Translate() [2/2]

void AbstractBoundingSphericalShell::Translate ( const Vector3d & _v )

overridevirtual

Translate the boundary.

Parameters

_v	The offset to apply.

Implements Boundary.

◆ Write()

void AbstractBoundingSphericalShell::Write ( std::ostream & _os ) const

overridevirtual

Write out a boundary.

Parameters

_os	The output stream to write to.

Implements Boundary.

The documentation for this class was generated from the following files:

/opt/actions-runner/_work/open-ppl/open-ppl/src/Geometry/Boundaries/AbstractBoundingSphericalShell.h
/opt/actions-runner/_work/open-ppl/open-ppl/src/Geometry/Boundaries/AbstractBoundingSphericalShell.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AbstractBoundingSphericalShell() [1/3]

◆ AbstractBoundingSphericalShell() [2/3]

◆ AbstractBoundingSphericalShell() [3/3]

◆ ~AbstractBoundingSphericalShell()

Member Function Documentation

◆ GetCenter()

◆ GetClearance()

◆ GetClearancePoint()

◆ GetDimension()

◆ GetMaxDist()

◆ GetRandomPoint()

◆ GetRange()

◆ GetVolume()

◆ InBoundary() [1/4]

◆ InBoundary() [2/4]

◆ InBoundary() [3/4]

◆ InBoundary() [4/4]

◆ PushInside()

◆ Read()

◆ ResetBoundary()

◆ SetCenter()

◆ Translate() [1/2]

◆ Translate() [2/2]

◆ Write()