Interior-point-optimisation  1.0-1
Interior-pointoptimisationlibrary
ipo Namespace Reference

This namespace holds all the interior-point optimisation classes. More...

Namespaces

 detail
 Namespace for classes that handle details of interior-point optimisation that are not ordinarily accessed directly to set up and solve a convex optimisation problem.
 
 format
 Namespace for operations and constants that allow us to format numbers.
 

Classes

class  Array
 This class represents an array of Variable objects. More...
 
class  Constraint
 Class for a constraint function. More...
 
class  IPOException
 Objects of this class are used to store information about an exception generated by ipo objects and functions at runtime. More...
 
class  LinearConstraint
 Class to represent a linear combination as an Objective or Constraint. More...
 
class  Model
 Model an interior-point optimisation problem. More...
 
class  Objective
 Class for an objective function. More...
 
class  Variable
 This class represents a variable. More...
 

Functions

bool operator== (Array const &lhs, Array const &rhs)
 Compare two Array objects. More...
 
bool operator!= (Array const &lhs, Array const &rhs)
 Compare two Array objects. More...
 
bool operator< (Array const &lhs, Array const &rhs)
 Compare two Array objects. More...
 
bool operator<= (Array const &lhs, Array const &rhs)
 Compare two Array objects. More...
 
bool operator> (Array const &lhs, Array const &rhs)
 Compare two Array objects. More...
 
bool operator>= (Array const &lhs, Array const &rhs)
 Compare two Array objects. More...
 
void swap (Array &first, Array &second)
 Swap contents of container with those of another. More...
 
bool operator== (Constraint const &lhs, Constraint const &rhs)
 Compare two Constraint objects. More...
 
bool operator== (Variable const &lhs, Variable const &rhs)
 Compare two Variable objects. More...
 
bool operator< (Variable const &lhs, Variable const &rhs)
 Compare two Variable objects. More...
 

Variables

double constexpr infinity = std::numeric_limits<double>::infinity()
 Infinity: use for unbounded variables. More...
 
double constexpr minusInfinity = -std::numeric_limits<double>::infinity()
 Negative infinity: use for unbounded variables. More...
 

Detailed Description

This namespace holds all the interior-point optimisation classes.

Function Documentation

bool ipo::operator!= ( Array const &  lhs,
Array const &  rhs 
)
inline

Compare two Array objects.

Parameters
lhsThe left object
rhsThe right object
Returns
true or false according as lhs == rhs or not

Definition at line 696 of file Array.hpp.

References ipo::Array::dataArray.

bool ipo::operator< ( Variable const &  lhs,
Variable const &  rhs 
)

Compare two Variable objects.

This compares by pointers and so guarantees a unique ordering of a set of Variable objects.

Parameters
lhsThe left object
rhsThe right object
Returns
true or false according as lhs < rhs or not

Definition at line 123 of file Variable.cc.

References ipo::Variable::data.

bool ipo::operator< ( Array const &  lhs,
Array const &  rhs 
)
inline

Compare two Array objects.

Parameters
lhsThe left object
rhsThe right object
Returns
true or false according as lhs < rhs or not

Definition at line 704 of file Array.hpp.

References ipo::Array::dataArray.

bool ipo::operator<= ( Array const &  lhs,
Array const &  rhs 
)
inline

Compare two Array objects.

Parameters
lhsThe left object
rhsThe right object
Returns
true or false according as lhs <= rhs or not

Definition at line 712 of file Array.hpp.

References ipo::Array::dataArray.

bool ipo::operator== ( Constraint const &  lhs,
Constraint const &  rhs 
)

Compare two Constraint objects.

Parameters
lhsThe left object
rhsThe right object
Returns
true or false according as lhs == rhs or not

Definition at line 77 of file Constraint.cc.

References ipo::Objective::data.

bool ipo::operator== ( Variable const &  lhs,
Variable const &  rhs 
)

Compare two Variable objects.

Parameters
lhsThe left object
rhsThe right object
Returns
true or false according as lhs == rhs or not

Definition at line 118 of file Variable.cc.

References ipo::Variable::data.

bool ipo::operator== ( Array const &  lhs,
Array const &  rhs 
)
inline

Compare two Array objects.

Parameters
lhsThe left object
rhsThe right object
Returns
true or false according as lhs == rhs or not

Definition at line 688 of file Array.hpp.

References ipo::Array::dataArray.

bool ipo::operator> ( Array const &  lhs,
Array const &  rhs 
)
inline

Compare two Array objects.

Parameters
lhsThe left object
rhsThe right object
Returns
true or false according as lhs > rhs or not

Definition at line 720 of file Array.hpp.

References ipo::Array::dataArray.

bool ipo::operator>= ( Array const &  lhs,
Array const &  rhs 
)
inline

Compare two Array objects.

Parameters
lhsThe left object
rhsThe right object
Returns
true or false according as lhs >= rhs or not

Definition at line 728 of file Array.hpp.

References ipo::Array::dataArray.

void ipo::swap ( Array &  first,
Array &  second 
)
inline

Swap contents of container with those of another.

Parameters
firstFirst Array to swap
secondSecond Array to swap

Definition at line 736 of file Array.hpp.

References ipo::Array::swap().

Referenced by ipo::Array::operator=(), ipo::detail::SharedFunctionPtr::SharedFunctionPtr(), ipo::detail::SharedFunctionPtr::swap(), and ipo::Array::swap().

Variable Documentation