aikido::constraint::FiniteSampleable Class Reference

Constraint that always returns a finite set of samples. More...

#include <aikido/constraint/FiniteSampleable.hpp>

Inheritance diagram for aikido::constraint::FiniteSampleable:

Public Member Functions
	FiniteSampleable (statespace::StateSpacePtr _stateSpace, const statespace::StateSpace::State *_state)
	Constructor for single-sample constraint. More...
	FiniteSampleable (statespace::StateSpacePtr _stateSpace, const std::vector< const statespace::StateSpace::State * > &_states)
	Constructor for multiple samples. More...
	FiniteSampleable (const FiniteSampleable &other)=delete
	FiniteSampleable (FiniteSampleable &&other)=delete
FiniteSampleable &	operator= (const FiniteSampleable &other)=delete
FiniteSampleable &	operator= (FiniteSampleable &&other)=delete
virtual	~FiniteSampleable ()
statespace::ConstStateSpacePtr	getStateSpace () const override
	Gets the StateSpace that this constraint operates on. More...
std::unique_ptr< SampleGenerator >	createSampleGenerator () const override
	Creates a SampleGenerator for sampling from this constraint. More...
Public Member Functions inherited from aikido::constraint::Sampleable
virtual	~Sampleable ()=default

Private Attributes
statespace::ConstStateSpacePtr	mStateSpace
std::vector< statespace::StateSpace::State * >	mStates

Detailed Description

Constraint that always returns a finite set of samples.

Its SampleGenerator will generate sample until all samples are exhausted.

Constructor & Destructor Documentation

FiniteSampleable() [1/4]

aikido::constraint::FiniteSampleable::FiniteSampleable	(	statespace::StateSpacePtr	_stateSpace,
		const statespace::StateSpace::State *	_state
	)

Constructor for single-sample constraint.

Parameters

_stateSpace	StateSpace in which _state belongs.
_state	The only sample in this constraint.

FiniteSampleable() [2/4]

aikido::constraint::FiniteSampleable::FiniteSampleable	(	statespace::StateSpacePtr	_stateSpace,
		const std::vector< const statespace::StateSpace::State * > &	_states
	)

Constructor for multiple samples.

Parameters

_stateSpace	StateSpace in which _states belong.
_states	Samples in this constraint. SampleGenerator will generate samples in this order.

FiniteSampleable() [3/4]

aikido::constraint::FiniteSampleable::FiniteSampleable ( const FiniteSampleable &  other )

delete

FiniteSampleable() [4/4]

aikido::constraint::FiniteSampleable::FiniteSampleable ( FiniteSampleable &&  other )

delete

~FiniteSampleable()

virtual aikido::constraint::FiniteSampleable::~FiniteSampleable ( )

virtual

Member Function Documentation

createSampleGenerator()

std::unique_ptr<SampleGenerator> aikido::constraint::FiniteSampleable::createSampleGenerator ( ) const

overridevirtual

Creates a SampleGenerator for sampling from this constraint.

Implements aikido::constraint::Sampleable.

getStateSpace()

statespace::ConstStateSpacePtr aikido::constraint::FiniteSampleable::getStateSpace ( ) const

overridevirtual

Gets the StateSpace that this constraint operates on.

Implements aikido::constraint::Sampleable.

operator=() [1/2]

FiniteSampleable& aikido::constraint::FiniteSampleable::operator= ( const FiniteSampleable &  other )

delete

operator=() [2/2]

FiniteSampleable& aikido::constraint::FiniteSampleable::operator= ( FiniteSampleable &&  other )

delete

Member Data Documentation

mStates

std::vector<statespace::StateSpace::State*> aikido::constraint::FiniteSampleable::mStates

private

mStateSpace

statespace::ConstStateSpacePtr aikido::constraint::FiniteSampleable::mStateSpace

private