tvm::constraint::internal::RHSVectors Class Reference

#include <tvm/constraint/internal/RHSVectors.h>

Public Member Functions
	RHSVectors (Type ct, RHS cr)
void	resize (int n)
Eigen::VectorXd &	l ()
const Eigen::VectorXd &	l () const
Eigen::VectorXd &	u ()
const Eigen::VectorXd &	u () const
Eigen::VectorXd &	e ()
const Eigen::VectorXd &	e () const
Eigen::VectorXd &	rhs (Type t)
const Eigen::VectorXd &	rhs (Type t) const
bool	use_l () const
bool	use_u () const
bool	use_e () const

Detailed Description

This class manages the vectors l, u and e that appear in the various types of constraints.

Constructor & Destructor Documentation

RHSVectors()

tvm::constraint::internal::RHSVectors::RHSVectors	(	Type	ct,
		RHS	cr
	)

Create a instance for the given conventions

Parameters

ct	The constraint type
cr	The type of "right hand side"

Member Function Documentation

e() [1/2]

Eigen::VectorXd & tvm::constraint::internal::RHSVectors::e ( )

inline

Return vector e

Attention

This does not check if e is in use

e() [2/2]

const Eigen::VectorXd & tvm::constraint::internal::RHSVectors::e ( ) const

inline

Return vector e (const version)

Attention

This does not check if e is in use

l() [1/2]

Eigen::VectorXd & tvm::constraint::internal::RHSVectors::l ( )

inline

Return vector l

Attention

This does not check if l is in use

l() [2/2]

const Eigen::VectorXd & tvm::constraint::internal::RHSVectors::l ( ) const

inline

Return vector l (const version)

Attention

This does not check if l is in use

resize()

void tvm::constraint::internal::RHSVectors::resize

(

int

n

)

Resize the vectors used to size n.

rhs() [1/2]

Eigen::VectorXd & tvm::constraint::internal::RHSVectors::rhs ( Type  t )

inline

Return the vector specified by t:

• l if t == Type::GREATER_THAN
• u if t == Type::LOWER_THAN
• e if t == Type::EQUAL If t == Type::DOUBLE_SIDED, throw an exception

rhs() [2/2]

const Eigen::VectorXd & tvm::constraint::internal::RHSVectors::rhs ( Type  t ) const

inline

Return the vector specified by t (const version):

• l if t == Type::GREATER_THAN
• u if t == Type::LOWER_THAN
• e if t == Type::EQUAL If t == Type::DOUBLE_SIDED, throw an exception

u() [1/2]

Eigen::VectorXd & tvm::constraint::internal::RHSVectors::u ( )

inline

Return vector u

Attention

This does not check if u is in use

u() [2/2]

const Eigen::VectorXd & tvm::constraint::internal::RHSVectors::u ( ) const

inline

Return vector u(const version)

Attention

This does not check if u is in use

use_e()

bool tvm::constraint::internal::RHSVectors::use_e ( ) const

inline

Check if e is used.

use_l()

bool tvm::constraint::internal::RHSVectors::use_l ( ) const

inline

Check if l is used.

use_u()

bool tvm::constraint::internal::RHSVectors::use_u ( ) const

inline

Check if u is used.

---

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

• include/tvm/constraint/internal/RHSVectors.h