Detailed Description

Constraints abstract interface class.

Definition at line 117 of file constraints_base.h.

#include <constraints_base.h>

Inheritance diagram for humoto::constraints::ContainerBase:

Public Member Functions
Location	getCopyLocation (const std::size_t number_of_constraints, const std::size_t constraints_offset, const std::size_t number_of_variables) const
	Computes location of the copied constraints in a container and verifies their consistency. More...

virtual std::size_t	getNumberOfConstraints () const =0
	Returns number of constraints in the task. More...

std::size_t	getNumberOfVariables () const
	Returns number of variables in the task. More...

void	log (humoto::Logger &logger, const LogEntryName &parent=LogEntryName(), const std::string &name="constraints") const
	Log data. More...

Protected Member Functions
	ContainerBase ()

	~ContainerBase ()
	Protected destructor: prevent destruction of the child classes through a base pointer. More...

virtual void	logBody (humoto::Logger &logger, const LogEntryName &parent=LogEntryName(), const std::string &name="constraints") const =0
	Log body. More...

virtual void	logBounds (humoto::Logger &logger, const LogEntryName &parent=LogEntryName(), const std::string &name="constraints") const =0
	Log bounds. More...

void	reset (const std::size_t number_of_constraints=0, const std::size_t number_of_variables=0, const bool initialize_matrices=false)
	Initialize constraints. More...

virtual void	resetBody (const std::size_t number_of_constraints=0, const bool initialize_matrices=false)=0
	Reset body of constraints (matrix A or I) More...

virtual void	resetBounds (const std::size_t number_of_constraints=0, const bool initialize_matrices=false)=0
	Reset bounds of constraints (b, lb, ub) More...

void	setNumberOfVariables (const std::size_t number_of_variables)
	Set number of variables. More...

Protected Attributes
std::size_t	number_of_variables_

Constructor & Destructor Documentation

◆ ~ContainerBase()

humoto::constraints::ContainerBase::~ContainerBase ( )

inlineprotected

Protected destructor: prevent destruction of the child classes through a base pointer.

Definition at line 128 of file constraints_base.h.

◆ ContainerBase()

humoto::constraints::ContainerBase::ContainerBase ( )

inlineprotected

Definition at line 131 of file constraints_base.h.

Member Function Documentation

◆ getCopyLocation()

Location humoto::constraints::ContainerBase::getCopyLocation	(	const std::size_t	number_of_constraints,
		const std::size_t	constraints_offset,
		const std::size_t	number_of_variables
	)		const

inline

Computes location of the copied constraints in a container and verifies their consistency.

Parameters

[in]	number_of_constraints	number of added constraints
[in]	constraints_offset	offset in the container
[in]	number_of_variables	number of variables in the container

Returns: Location

Definition at line 262 of file constraints_base.h.

◆ getNumberOfConstraints()

virtual std::size_t humoto::constraints::ContainerBase::getNumberOfConstraints ( ) const

pure virtual

Returns number of constraints in the task.

Returns: number of constraints

◆ getNumberOfVariables()

std::size_t humoto::constraints::ContainerBase::getNumberOfVariables ( ) const

inline

Returns number of variables in the task.

Returns: number of variables

Definition at line 215 of file constraints_base.h.

◆ log()

void humoto::constraints::ContainerBase::log	(	humoto::Logger &	logger,
		const LogEntryName &	parent = `LogEntryName()`,
		const std::string &	name = `"constraints"`
	)		const

inline

Log data.

Parameters

[in,out]	logger	logger
[in]	parent	parent
[in]	name	name

Definition at line 238 of file constraints_base.h.

◆ logBody()

virtual void humoto::constraints::ContainerBase::logBody	(	humoto::Logger &	logger,
		const LogEntryName &	parent = `LogEntryName()`,
		const std::string &	name = `"constraints"`
	)		const

protectedpure virtual

Log body.

Parameters

[in,out]	logger	logger
[in]	parent	parent
[in]	name	name

◆ logBounds()

virtual void humoto::constraints::ContainerBase::logBounds	(	humoto::Logger &	logger,
		const LogEntryName &	parent = `LogEntryName()`,
		const std::string &	name = `"constraints"`
	)		const

protectedpure virtual

Log bounds.

Parameters

[in,out]	logger	logger
[in]	parent	parent
[in]	name	name

◆ reset()

void humoto::constraints::ContainerBase::reset	(	const std::size_t	number_of_constraints = `0`,
		const std::size_t	number_of_variables = `0`,
		const bool	initialize_matrices = `false`
	)

inlineprotected

Initialize constraints.

Parameters

[in]	number_of_constraints	number of constraints
[in]	number_of_variables	number of variables
[in]	initialize_matrices	initialize matrices using defaults

Definition at line 175 of file constraints_base.h.

◆ resetBody()

virtual void humoto::constraints::ContainerBase::resetBody	(	const std::size_t	number_of_constraints = `0`,
		const bool	initialize_matrices = `false`
	)

protectedpure virtual

Reset body of constraints (matrix A or I)

Parameters

[in]	number_of_constraints	number of constraints
[in]	initialize_matrices	initialize matrices using defaults

◆ resetBounds()

virtual void humoto::constraints::ContainerBase::resetBounds	(	const std::size_t	number_of_constraints = `0`,
		const bool	initialize_matrices = `false`
	)

protectedpure virtual

Reset bounds of constraints (b, lb, ub)

Parameters

[in]	number_of_constraints	number of constraints
[in]	initialize_matrices	initialize matrices using defaults

◆ setNumberOfVariables()

void humoto::constraints::ContainerBase::setNumberOfVariables ( const std::size_t number_of_variables )

inlineprotected

Set number of variables.

Parameters

[in] number_of_variables number of variables

Definition at line 142 of file constraints_base.h.

Member Data Documentation

◆ number_of_variables_

std::size_t humoto::constraints::ContainerBase::number_of_variables_

protected

Definition at line 120 of file constraints_base.h.

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

core/include/humoto/constraints_base.h

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ ~ContainerBase()

◆ ContainerBase()

Member Function Documentation

◆ getCopyLocation()

◆ getNumberOfConstraints()

◆ getNumberOfVariables()

◆ log()

◆ logBody()

◆ logBounds()

◆ reset()

◆ resetBody()

◆ resetBounds()

◆ setNumberOfVariables()

Member Data Documentation

◆ number_of_variables_