detail namespace gathers internal classes and functions. More...

Data Structures
struct	BoundedLatticePolytopeSpecializer
	Aim: It is just a helper class for BoundedLatticePolytope to add dimension specific static methods. More...

struct	BoundedLatticePolytopeSpecializer< 3, TInteger >
	Aim: 3D specialization for BoundedLatticePolytope to add dimension specific static methods. More...

struct	BoundedRationalPolytopeSpecializer
	Aim: It is just a helper class for BoundedRationalPolytope to add dimension specific static methods. More...

struct	BoundedRationalPolytopeSpecializer< 3, TInteger >
	Aim: 3D specialization for BoundedRationalPolytope to add dimension specific static methods. More...

struct	ComparatorAdapter

struct	ComparatorAdapter< Container, true, false, false >
	unordered set-like adapter. More...

struct	ComparatorAdapter< Container, true, false, true >
	unordered map-like adapter. More...

struct	ComparatorAdapter< Container, true, true, false >
	Set-like adapter. More...

struct	ComparatorAdapter< Container, true, true, true >
	Map-like adapter. More...

struct	CurvatureFromDCA

struct	CurvatureFromDCA< false >

class	CurvatureFromDSSBaseEstimator

struct	CurvatureFromDSSLength

struct	CurvatureFromDSSLengthAndWidth

struct	DistanceFromDCA

class	DSSDecorator
	Aim: Abstract DSSDecorator for ArithmeticalDSSComputer. Has 2 virtual methods returning the first and last leaning point: More...

class	DSSDecorator4ConcavePart
	Aim: adapter for TDSS used by FP in CONCAVE parts. Has 2 methods: More...

class	DSSDecorator4ConvexPart
	Aim: adapter for TDSS used by FP in CONVEX parts. Has 2 methods: More...

struct	EqualPredicateFromLessThanComparator

struct	EuclideanDivisionHelper
	Aim: Small stucture that provides a static method returning the Euclidean division of two integers. More...

struct	EuclideanDivisionHelper< double >

struct	EuclideanDivisionHelper< float >

struct	EuclideanDivisionHelper< long double >

struct	FFTWComplexCast
	Facility to cast to the complex type used by fftw. More...

struct	FFTWWrapper
	Wrapper to fftw functions depending on value type. More...

struct	FFTWWrapper< double >

struct	FFTWWrapper< float >

struct	FFTWWrapper< long double >

struct	HasNestedTypeCategory
	Aim: Checks whether type T has a nested type called 'Category' or not. NB: from en.wikipedia.org/wiki/Substitution_failure_is_not_an_error NB: to avoid various compiler issues, we use BOOST_STATIC_CONSTANT according to http://www.boost.org/development/int_const_guidelines.html. More...

struct	HasNestedTypeType
	Aim: Checks whether type IC has a nested type called 'Type' or not. NB: from en.wikipedia.org/wiki/Substitution_failure_is_not_an_error NB: to avoid various compiler issues, we use BOOST_STATIC_CONSTANT according to http://www.boost.org/development/int_const_guidelines.html. More...

struct	IsAssociativeContainerFromCategory

struct	IsCirculator
	Aim: Checks whether type IC is a circular or a classical iterator. Static value set to 'true' for a circulator, 'false' otherwise. 1) if type IC has no nested type 'Type', it is a classical iterator and 'false' is returned. 2) if type IC has a nested type 'Type', 'true' is returned is 'Type' is CirculatorType, 'false' otherwise. More...

struct	IsCirculator< IC, true >

struct	IsCirculatorFromType
	Aim: In order to check whether type IC is a circular or a classical iterator, the nested type called 'Type' is read. More...

struct	IsCirculatorFromType< IC, CirculatorType >

struct	IsContainerFromCategory

struct	IsMultipleAssociativeContainerFromCategory

struct	IsOrderedAssociativeContainerFromCategory

struct	IsPairAssociativeContainerFromCategory

struct	IsSequenceContainerFromCategory

struct	IsSimpleAssociativeContainerFromCategory

struct	IsUniqueAssociativeContainerFromCategory

struct	IsUnorderedAssociativeContainerFromCategory

struct	IteratorCirculatorTypeImpl
	Aim: Defines the Iterator or Circulator type as a nested type according to the value of b. More...

struct	IteratorCirculatorTypeImpl< true >

struct	KeyComparatorForPairKeyData

struct	LabelledMapMemFunctor

struct	monomial_node

struct	NormalizedTangentVectorFromDSS

struct	NormalVectorFromDCA

class	PointValueCompare
	Aim: Small binary predicate to order candidates points according to their (absolute) distance value. More...

class	PosDepScaleDepSCEstimator

class	PosDepScaleIndepSCEstimator

class	PosIndepScaleDepSCEstimator

class	PosIndepScaleIndepSCEstimator

struct	power_node

struct	SetFunctionsImpl
	Aim: Specialize set operations (union, intersection, difference, symmetric_difference) according to the given type of container. It uses standard algorithms when containers are ordered, otherwise it provides a default implementation. More...

struct	SetFunctionsImpl< Container, false, true >

struct	SetFunctionsImpl< Container, true, false >

struct	SetFunctionsImpl< Container, true, true >

struct	TangentAngleFromDSS

struct	TangentVectorFromDCA

struct	TangentVectorFromDSS

struct	toCoordinateImpl
	Aim: Define a simple functor that can cast a signed integer (possibly a DGtal::BigInteger) into another. More...

struct	toCoordinateImpl< DGtal::BigInteger, DGtal::BigInteger >

struct	toCoordinateImpl< DGtal::BigInteger, TOutput >

struct	top_node

struct	ValueConverter
	Generic definition of a class for converting type X toward type Y. More...

struct	ValueConverter< std::string, double >
	Specialized definitions of a class for converting type X toward type Y. More...

struct	ValueConverter< std::string, float >
	Specialized definitions of a class for converting type X toward type Y. More...

struct	ValueConverter< std::string, int >
	Specialized definitions of a class for converting type X toward type Y. More...

struct	ValueConverter< X, std::string >
	Specialized definitions of a class for converting type X toward type Y. More...

Typedefs
typedef boost::variant< boost::recursive_wrapper< top_node >, monomial_node >	expr_node

Functions
template<typename IC >
bool	isNotEmpty (const IC &itb, const IC &ite, IteratorType)

template<typename IC >
bool	isNotEmpty (const IC &c1, const IC &c2, CirculatorType)

template<typename IC >
void	advanceIterator (IC &ic, typename IteratorCirculatorTraits< IC >::Difference n, ForwardCategory)

template<typename IC >
void	advanceIterator (IC &ic, typename IteratorCirculatorTraits< IC >::Difference n, RandomAccessCategory)

template<typename I >
IteratorCirculatorTraits< I >::Difference	rangeSize (const I &itb, const I &ite, IteratorType, ForwardCategory)

template<typename C >
IteratorCirculatorTraits< C >::Difference	rangeSize (const C &cb, const C &ce, CirculatorType, ForwardCategory)

template<typename I >
IteratorCirculatorTraits< I >::Difference	rangeSize (const I &itb, const I &ite, IteratorType, RandomAccessCategory)

template<typename C >
IteratorCirculatorTraits< C >::Difference	rangeSize (const C &cb, const C &ce, CirculatorType, RandomAccessCategory)

template<typename I >
I	rangeMiddle (const I &itb, const I &ite, IteratorType, ForwardCategory)

template<typename C >
C	rangeMiddle (const C &cb, const C &ce, CirculatorType, ForwardCategory)

template<typename I >
I	rangeMiddle (const I &itb, const I &ite, IteratorType, BidirectionalCategory)

template<typename C >
C	rangeMiddle (const C &cb, const C &ce, CirculatorType, BidirectionalCategory)

template<typename I >
I	rangeMiddle (const I &itb, const I &ite, IteratorType, RandomAccessCategory)

template<typename C >
C	rangeMiddle (const C &cb, const C &ce, CirculatorType, RandomAccessCategory)

template<typename TData >
std::pair< unsigned int, unsigned int >	argminLabelledMapMemoryUsageForGeometricDistribution (unsigned int L, double prob_no_data, double prob_one_data)

Detailed Description

detail namespace gathers internal classes and functions.

Typedef Documentation

◆ expr_node

typedef boost::variant< boost::recursive_wrapper<top_node>, monomial_node > DGtal::detail::expr_node

Part of the polynomial tree structure. Either a top_node or a monomial.

Definition at line 87 of file MPolynomialReader.h.

Function Documentation

◆ advanceIterator() [1/2]

template<typename IC >

void DGtal::detail::advanceIterator	(	IC &	ic,
		typename IteratorCirculatorTraits< IC >::Difference	n,
		ForwardCategory
	)

inline

Moves ic at position @ it + n

Parameters

ic	any (circular)iterator
n	any positive distance

Template Parameters

IC	any iterator or circulator

◆ advanceIterator() [2/2]

template<typename IC >

void DGtal::detail::advanceIterator	(	IC &	ic,
		typename IteratorCirculatorTraits< IC >::Difference	n,
		RandomAccessCategory
	)

inline

Moves ic at position @ it + n

Parameters

ic	any (circular)iterator
n	any positive distance

Template Parameters

IC	any iterator or circulator

◆ argminLabelledMapMemoryUsageForGeometricDistribution()

template<typename TData >

std::pair< unsigned int, unsigned int > DGtal::detail::argminLabelledMapMemoryUsageForGeometricDistribution	(	unsigned int	L,
		double	prob_no_data,
		double	prob_one_data
	)

Tries to find the best values N and M which will minimized the memory usage of a LabelledMap, for the distribution specified by the parameters.

Template Parameters

TData the type of data that will be stored.

Parameters

L	the total number of labels.
prob_no_data	Probability that there is no data at this location.
prob_one_data	If there is a possibility to have a data, this probability is used to define a geometric distribution that defines the number of data (ie valid labels) at this place. The smaller, the higher is the expectation. 0.5 means E(X) = 1.

Returns: the pair (N,M) that minimizes the memory usage of a LabelledMap for the given distribution.

◆ isNotEmpty() [1/2]

template<typename IC >

bool DGtal::detail::isNotEmpty	(	const IC &	c1,
		const IC &	c2,
		CirculatorType
	)

inline

Checks if a circular range is not empty, ie. checks if the circulators are valid.

Parameters

c1	begin iterator of the range
c2	end iterator of the range

Template Parameters

IC	iterator or circulator

◆ isNotEmpty() [2/2]

template<typename IC >

bool DGtal::detail::isNotEmpty	(	const IC &	itb,
		const IC &	ite,
		IteratorType
	)

inline

Checks if the range of classical iterators [ itb , ite ) is not empty, ie. checks if itb != ite

Parameters

itb	begin iterator of the range
ite	end iterator of the range

Template Parameters

IC	iterator or circulator

Referenced by DGtal::detail::CurvatureFromDSSBaseEstimator< DSSComputer, detail::CurvatureFromDSSLength >::eval(), DGtal::detail::PosIndepScaleIndepSCEstimator< DSSComputer, detail::TangentAngleFromDSS >::eval(), DGtal::detail::PosIndepScaleDepSCEstimator< DCAComputer, detail::CurvatureFromDCA< true > >::eval(), DGtal::detail::PosDepScaleIndepSCEstimator< DCAComputer, detail::TangentVectorFromDCA >::eval(), and DGtal::detail::PosDepScaleDepSCEstimator< DCAComputer, detail::DistanceFromDCA >::eval().

◆ rangeMiddle() [1/6]

template<typename C >

C DGtal::detail::rangeMiddle	(	const C &	cb,
		const C &	ce,
		CirculatorType	,
		BidirectionalCategory
	)

inline

Computes the middle of a given range [ cb, ce ). Note that if cb = ce then [ cb, ce ) is assumed to be a whole range.

Parameters

cb	begin iterator of the range
ce	end iterator of the range

Returns: the middle circulator of the range [ cb , ce ) NB: linear in the range size

Template Parameters

C	any circulator

◆ rangeMiddle() [2/6]

template<typename C >

C DGtal::detail::rangeMiddle	(	const C &	cb,
		const C &	ce,
		CirculatorType	,
		ForwardCategory
	)

inline

Computes the middle of a given range [ cb, ce ). Note that if cb = ce then [ cb, ce ) is assumed to be a whole range.

Parameters

cb	begin iterator of the range
ce	end iterator of the range

Returns: the middle circulator of the range [ cb , ce ) NB: linear in the range size

Template Parameters

C	any circulator

◆ rangeMiddle() [3/6]

template<typename C >

C DGtal::detail::rangeMiddle	(	const C &	cb,
		const C &	ce,
		CirculatorType	,
		RandomAccessCategory
	)

inline

Computes the middle of a given range [ cb, ce ). Note that if cb = ce then [ cb, ce ) is assumed to be a whole range.

Parameters

cb	begin iterator of the range
ce	end iterator of the range

Returns: the middle circulator of the range [ cb , ce ) NB: in O(1)

Template Parameters

C	any circulator

◆ rangeMiddle() [4/6]

template<typename I >

I DGtal::detail::rangeMiddle	(	const I &	itb,
		const I &	ite,
		IteratorType	,
		BidirectionalCategory
	)

inline

Computes the middle of a given range [ itb , ite )

Parameters

itb	begin iterator of the range
ite	end iterator of the range

Returns: the middle iterator of the range [ itb , ite ) NB: in O(ite-itb)

Template Parameters

I	any iterator

◆ rangeMiddle() [5/6]

template<typename I >

I DGtal::detail::rangeMiddle	(	const I &	itb,
		const I &	ite,
		IteratorType	,
		ForwardCategory
	)

inline

Computes the middle of a given range [ itb , ite ).

Parameters

itb	begin iterator of the range
ite	end iterator of the range

Returns: the middle iterator of the range [ itb , ite ) NB: in O(ite-itb)

Template Parameters

I	any iterator

◆ rangeMiddle() [6/6]

template<typename I >

I DGtal::detail::rangeMiddle	(	const I &	itb,
		const I &	ite,
		IteratorType	,
		RandomAccessCategory
	)

inline

Computes the middle of a given range [ itb , ite )

Parameters

itb	begin iterator of the range
ite	end iterator of the range

Returns: the middle iterator of the range [ itb , ite ) NB: in O(1)

Template Parameters

I	any iterator

◆ rangeSize() [1/4]

template<typename C >

IteratorCirculatorTraits<C>::Difference DGtal::detail::rangeSize	(	const C &	cb,
		const C &	ce,
		CirculatorType	,
		ForwardCategory
	)

inline

Computes the size of a given range [ cb, ce ). Note that if cb = ce then [ cb, ce ) is assumed to be a whole range.

Parameters

cb	begin iterator of the range
ce	end iterator of the range

Returns: the size NB: linear in the range size

Template Parameters

C	any circulator

◆ rangeSize() [2/4]

template<typename C >

IteratorCirculatorTraits<C>::Difference DGtal::detail::rangeSize	(	const C &	cb,
		const C &	ce,
		CirculatorType	,
		RandomAccessCategory
	)

inline

Computes the size of a given range [ cb, ce ). Note that if cb = ce then [ cb, ce ) is assumed to be a whole range.

Parameters

cb	begin iterator of the range
ce	end iterator of the range

Returns: the size NB: in O(1)

Template Parameters

C	any circulator

◆ rangeSize() [3/4]

template<typename I >

IteratorCirculatorTraits<I>::Difference DGtal::detail::rangeSize	(	const I &	itb,
		const I &	ite,
		IteratorType	,
		ForwardCategory
	)

inline

Computes the size of a given range [ itb , ite )

Parameters

itb	begin iterator of the range
ite	end iterator of the range

Returns: the size NB: in O(ite-itb)

Template Parameters

I	any iterator

◆ rangeSize() [4/4]

template<typename I >

IteratorCirculatorTraits<I>::Difference DGtal::detail::rangeSize	(	const I &	itb,
		const I &	ite,
		IteratorType	,
		RandomAccessCategory
	)

inline

Computes the size of a given range [ itb , ite )

Parameters

itb	begin iterator of the range
ite	end iterator of the range

Returns: the size NB: in O(1)

Template Parameters

I	any iterator

Data Structures

Typedefs

Functions

Detailed Description

Typedef Documentation

◆ expr_node

Function Documentation

◆ advanceIterator() [1/2]

◆ advanceIterator() [2/2]

◆ argminLabelledMapMemoryUsageForGeometricDistribution()

◆ isNotEmpty() [1/2]

◆ isNotEmpty() [2/2]

◆ rangeMiddle() [1/6]

◆ rangeMiddle() [2/6]

◆ rangeMiddle() [3/6]

◆ rangeMiddle() [4/6]

◆ rangeMiddle() [5/6]

◆ rangeMiddle() [6/6]

◆ rangeSize() [1/4]

◆ rangeSize() [2/4]

◆ rangeSize() [3/4]

◆ rangeSize() [4/4]