tvm::scheme::HierarchicalLeastSquares Class Reference

#include <tvm/scheme/HierarchicalLeastSquares.h>

Inheritance diagram for tvm::scheme::HierarchicalLeastSquares:

Collaboration diagram for tvm::scheme::HierarchicalLeastSquares:

Public Types
using	ComputationDataType = Memory

Public Member Functions
template<class SolverFactory , typename std::enable_if< isFactory< SolverFactory >::value, int >::type = 0>
	HierarchicalLeastSquares (const SolverFactory &solverFactory, HierarchicalLeastSquaresOptions schemeOptions={})
template<class SolverOptions , typename std::enable_if< isHLSSolverFactoryOption< SolverOptions >::value, int >::type = 0>
	HierarchicalLeastSquares (const SolverOptions &solverOptions, HierarchicalLeastSquaresOptions schemeOptions={})
template<typename T , typename std::enable_if<!isFactory< T >::value &&!isHLSSolverFactoryOption< T >::value, int >::type = 0>
	HierarchicalLeastSquares (const T &, HierarchicalLeastSquaresOptions={})
	HierarchicalLeastSquares (const HierarchicalLeastSquares &)=delete
	HierarchicalLeastSquares (HierarchicalLeastSquares &&)=delete
HierarchicalLeastSquares &	operator= (const HierarchicalLeastSquares &)=delete
HierarchicalLeastSquares &	operator= (HierarchicalLeastSquares &&)=delete
bool	solve_ (const LinearizedControlProblem &problem, internal::ProblemComputationData *data) const
void	updateComputationData_ (const LinearizedControlProblem &problem, internal::ProblemComputationData *data) const
std::unique_ptr< Memory >	createComputationData_ (const LinearizedControlProblem &problem) const
Public Member Functions inherited from tvm::scheme::abstract::ResolutionScheme< Derived >
template<typename Problem >
bool	solve (Problem &problem) const
template<typename Problem >
std::unique_ptr< internal::ProblemComputationData >	createComputationData (const Problem &problem) const
template<typename Problem >
void	updateComputationData (const Problem &problem, internal::ProblemComputationData *data) const
Derived &	derived ()
const Derived &	derived () const
Public Member Functions inherited from tvm::scheme::internal::ResolutionSchemeBase
double	big_number () const
void	big_number (double big)
Public Member Functions inherited from tvm::internal::ObjWithId
	ObjWithId (const ObjWithId &)=delete
	ObjWithId (ObjWithId &&other)
ObjWithId &	operator= (const ObjWithId &)=delete
ObjWithId &	operator= (ObjWithId &&other)
int	id () const

Protected Member Functions
void	resetComputationData (const LinearizedControlProblem &problem, Memory *memory) const
void	processProblem (const LinearizedControlProblem &problem, Memory *memory) const
void	addTask (const LinearizedControlProblem &problem, Memory *memory, const TaskWithRequirements &task, solver::internal::SolverEvents &se) const
void	removeTask (const LinearizedControlProblem &problem, Memory *memory, const TaskWithRequirements &task, solver::internal::SolverEvents &se) const
Protected Member Functions inherited from tvm::scheme::abstract::LinearResolutionScheme< HierarchicalLeastSquares >
	LinearResolutionScheme (internal::SchemeAbilities abilities, double big=constant::big_number)
Protected Member Functions inherited from tvm::scheme::abstract::ResolutionScheme< Derived >
	ResolutionScheme (internal::SchemeAbilities abilities, double big=constant::big_number)
Protected Member Functions inherited from tvm::scheme::internal::ResolutionSchemeBase
	ResolutionSchemeBase (SchemeAbilities abilities, double big=constant::big_number)
Protected Member Functions inherited from tvm::internal::ObjWithId
	ObjWithId ()

Protected Attributes
HierarchicalLeastSquaresOptions	options_
std::unique_ptr< solver::abstract::HLSSolverFactory >	solverFactory_
Protected Attributes inherited from tvm::scheme::internal::ResolutionSchemeBase
SchemeAbilities	abilities_
double	big_number_

Detailed Description

This class implements the hierarchical least square scheme.

Member Typedef Documentation

ComputationDataType

using tvm::scheme::HierarchicalLeastSquares::ComputationDataType = Memory

Constructor & Destructor Documentation

HierarchicalLeastSquares() [1/5]

template<class SolverFactory , typename std::enable_if< isFactory< SolverFactory >::value, int >::type = 0>

tvm::scheme::HierarchicalLeastSquares::HierarchicalLeastSquares ( const SolverFactory &  solverFactory, HierarchicalLeastSquaresOptions  schemeOptions = {}  )

inline

Constructor from a HLSSolverFactory

Template Parameters

SolverFactory

Any class deriving from HLSSolverFactory.

Parameters

solverFactory	A factory for the solver that should be used in the resolution scheme.
schemeOptions	Options for the schemes. See tvm::scheme::HierarchicalLeastSquaresOptions.

HierarchicalLeastSquares() [2/5]

template<class SolverOptions , typename std::enable_if< isHLSSolverFactoryOption< SolverOptions >::value, int >::type = 0>

tvm::scheme::HierarchicalLeastSquares::HierarchicalLeastSquares ( const SolverOptions &  solverOptions, HierarchicalLeastSquaresOptions  schemeOptions = {}  )

inline

Constructor from a configuration class

Template Parameters

SolverOptions

Any class representing solver options. The class must have a member type Factory referring to a class C deriving from HLSSolverFactory and such that C can be constructed from SolverOptions.

Parameters

solverOptions	A set of options for the solver to be used by the resolution scheme.
schemeOptions	Options for the scheme. See tvm::Scheme::HierarchicalLeastSquaresOptions.

HierarchicalLeastSquares() [3/5]

template<typename T , typename std::enable_if<!isFactory< T >::value &&!isHLSSolverFactoryOption< T >::value, int >::type = 0>

tvm::scheme::HierarchicalLeastSquares::HierarchicalLeastSquares ( const T &  , HierarchicalLeastSquaresOptions  = {}  )

inline

A fallback constructor that is enabled when none of the others are. It always fails at compilation time to provide a nice error message.

HierarchicalLeastSquares() [4/5]

tvm::scheme::HierarchicalLeastSquares::HierarchicalLeastSquares ( const HierarchicalLeastSquares &  )

delete

HierarchicalLeastSquares() [5/5]

tvm::scheme::HierarchicalLeastSquares::HierarchicalLeastSquares ( HierarchicalLeastSquares &&  )

delete

Member Function Documentation

addTask()

void tvm::scheme::HierarchicalLeastSquares::addTask ( const LinearizedControlProblem &  problem, Memory *  memory, const TaskWithRequirements &  task, solver::internal::SolverEvents &  se  ) const

protected

createComputationData_()

std::unique_ptr<Memory> tvm::scheme::HierarchicalLeastSquares::createComputationData_

(

const LinearizedControlProblem &

problem

)

const

operator=() [1/2]

HierarchicalLeastSquares& tvm::scheme::HierarchicalLeastSquares::operator= ( const HierarchicalLeastSquares &  )

delete

operator=() [2/2]

HierarchicalLeastSquares& tvm::scheme::HierarchicalLeastSquares::operator= ( HierarchicalLeastSquares &&  )

delete

processProblem()

void tvm::scheme::HierarchicalLeastSquares::processProblem ( const LinearizedControlProblem &  problem, Memory *  memory  ) const

protected

removeTask()

void tvm::scheme::HierarchicalLeastSquares::removeTask ( const LinearizedControlProblem &  problem, Memory *  memory, const TaskWithRequirements &  task, solver::internal::SolverEvents &  se  ) const

protected

resetComputationData()

void tvm::scheme::HierarchicalLeastSquares::resetComputationData ( const LinearizedControlProblem &  problem, Memory *  memory  ) const

protected

solve_()

bool tvm::scheme::HierarchicalLeastSquares::solve_	(	const LinearizedControlProblem &	problem,
		internal::ProblemComputationData *	data
	)		const

Private interface for CRTP

updateComputationData_()

void tvm::scheme::HierarchicalLeastSquares::updateComputationData_	(	const LinearizedControlProblem &	problem,
		internal::ProblemComputationData *	data
	)		const

Member Data Documentation

options_

HierarchicalLeastSquaresOptions tvm::scheme::HierarchicalLeastSquares::options_

protected

solverFactory_

std::unique_ptr<solver::abstract::HLSSolverFactory> tvm::scheme::HierarchicalLeastSquares::solverFactory_

protected

The factory to create solvers attached to each problem.

---

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

• include/tvm/scheme/HierarchicalLeastSquares.h