Ponca::Basket< P, W, Ext0, Exts > Class Template Reference

Aggregator class used to declare specialized structures using CRTP. More...

#include <basket.h>

Inheritance diagram for Ponca::Basket< P, W, Ext0, Exts >:

Collaboration diagram for Ponca::Basket< P, W, Ext0, Exts >:

Public Types
using	Base = typename internal::BasketAggregate< P, W, Ext0, Exts... >::type
	Base type, which aggregates all the computational objects using the CRTP.
using	Scalar = typename P::Scalar
	Scalar type used for computation, as defined from template parameter P
using	DataPoint = P
	Point type used for computation.
using	WeightFunction = W
	Weighting function.

Public Member Functions
template<typename IteratorBegin , typename IteratorEnd >
FIT_RESULT	compute (const IteratorBegin &begin, const IteratorEnd &end)
	Convenience function for STL-like iterators
template<typename IndexRange , typename PointContainer >
FIT_RESULT	computeWithIds (IndexRange ids, const PointContainer &points)
	Convenience function to iterate over a subset of samples in a PointContainer
template<typename Container >
FIT_RESULT	compute (const Container &c)
	Convenience function for STL-like iterators
bool	addNeighbor (const DataPoint &_nei)
	Add a neighbor to perform the fit.

Detailed Description

template<class P, class W, template< class, class, typename > class Ext0, template< class, class, typename > class... Exts>
class Ponca::Basket< P, W, Ext0, Exts >

Aggregator class used to declare specialized structures using CRTP.

This is one of the central classes of the library (even if it does not perform any computation on its own). Checkout Fitting Module: User Manual for more details.

The various implementations of Ponca::Concept are mixed through specializations of the Basket class:

typedef
Basket <PointImpl,           // Implementation of PointConcept
WeightFuncImpl,              // Implementation of WeightFuncConcept
ComputationalObjectConcept1, // Implementation of ComputationalObjectConcept
ComputationalObjectConcept2, // Implementation of ComputationalObjectConcept
... ,                        //
> myFit;                     // Final structure to fit a primitive over weighted samples

See also

BasketDiff for the aggregation of ComputationalDerivativesConcept

Template Parameters

P	Implements PointConcept
W	Implements WeightKernelConcept
Ext0	Implements ComputationalObjectConcept
Exts	Implements ComputationalObjectConcept (optional)

Definition at line 210 of file basket.h.

Member Typedef Documentation

Base

template<class P , class W , template< class, class, typename > class Ext0, template< class, class, typename > class... Exts>

using Ponca::Basket< P, W, Ext0, Exts >::Base = typename internal::BasketAggregate<P, W, Ext0, Exts...>::type

Base type, which aggregates all the computational objects using the CRTP.

Definition at line 216 of file basket.h.

DataPoint

template<class P , class W , template< class, class, typename > class Ext0, template< class, class, typename > class... Exts>

using Ponca::Basket< P, W, Ext0, Exts >::DataPoint = P

Point type used for computation.

Definition at line 220 of file basket.h.

Scalar

template<class P , class W , template< class, class, typename > class Ext0, template< class, class, typename > class... Exts>

using Ponca::Basket< P, W, Ext0, Exts >::Scalar = typename P::Scalar

Scalar type used for computation, as defined from template parameter P

Definition at line 218 of file basket.h.

WeightFunction

template<class P , class W , template< class, class, typename > class Ext0, template< class, class, typename > class... Exts>

using Ponca::Basket< P, W, Ext0, Exts >::WeightFunction = W

Weighting function.

Definition at line 222 of file basket.h.

Member Function Documentation

addNeighbor()

template<class P , class W , template< class, class, typename > class Ext0, template< class, class, typename > class... Exts>

bool Ponca::Basket< P, W, Ext0, Exts >::addNeighbor ( const DataPoint &  _nei )

inline

Add a neighbor to perform the fit.

When called directly, don't forget to call PrimitiveBase::startNewPass when starting multiple passes

See also

compute Prefer when using a range of Points

computeWithIds Prefer when using a range of ids

Returns

false if param nei is not a valid neighbor (weight = 0)

Definition at line 232 of file basket.h.

compute() [1/2]

template<class P , class W , template< class, class, typename > class Ext0, template< class, class, typename > class... Exts>

template<typename Container >

FIT_RESULT Ponca::Basket< P, W, Ext0, Exts >::compute ( const Container &  c )

inline

Convenience function for STL-like iterators

Add neighbors stored in a container using STL-like iterators, and call finalize at the end.

The fit is evaluated multiple time if needed (see NEED_OTHER_PASS)

See also

addNeighbor()

Definition at line 224 of file basket.h.

compute() [2/2]

template<class P , class W , template< class, class, typename > class Ext0, template< class, class, typename > class... Exts>

template<typename IteratorBegin , typename IteratorEnd >

FIT_RESULT Ponca::Basket< P, W, Ext0, Exts >::compute ( const IteratorBegin &  begin, const IteratorEnd &  end  )

inline

Convenience function for STL-like iterators

Add neighbors stored in a container using STL-like iterators, and call finalize at the end.

The fit is evaluated multiple time if needed (see NEED_OTHER_PASS)

See also

addNeighbor()

Definition at line 224 of file basket.h.

computeWithIds()

template<class P , class W , template< class, class, typename > class Ext0, template< class, class, typename > class... Exts>

template<typename IndexRange , typename PointContainer >

FIT_RESULT Ponca::Basket< P, W, Ext0, Exts >::computeWithIds ( IndexRange  ids, const PointContainer &  points  )

inline

Convenience function to iterate over a subset of samples in a PointContainer

Add neighbors stored in a PointContainer and sampled using indices stored in ids.

Template Parameters

IndexRange	STL-Like range storing indices of the neighbors
PointContainer	STL-like container storing the points

See also

compute(const IteratorBegin& begin, const IteratorEnd& end)

Definition at line 224 of file basket.h.