ell_config.hpp File Reference

Configuration types and constants for the ellipsoid algorithm. More...

#include <cstddef>
#include <ostream>
#include <utility>

Include dependency graph for ell_config.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	Options
	Configuration options for the ellipsoid algorithm. More...
struct	CutResult
	Result of a cutting-plane calculation. More...
struct	CInfo
	Information about the cutting-plane computation result. More...

Typedefs
template<typename T >
using	ArrayType = typename T::ArrayType
	Type alias for the array type used by template parameter T.
template<typename T >
using	CutChoice = typename T::CutChoice
	Type alias for the cut choice type used by template parameter T.
template<typename T >
using	CutConcept = std::pair< ArrayType< T >, CutChoice< T > >
	Type alias for a cutting plane concept.
template<typename T >
using	RetQ = std::tuple< CutConcept< T >, bool, ArrayType< T >, bool >
	Type alias for return type of Q optimization.
using	SingleCut = double
	Single cut parameter β in gᵀ(x - xc) + β ≤ 0.

Enumerations
enum class	CutStatus { Success , NoSoln , NoEffect , Unknown }
	Status of cutting plane operations. More...

Functions
auto	operator<< (std::ostream &os, CutStatus s) -> std::ostream &
	Stream output operator for CutStatus.

Detailed Description

Configuration types and constants for the ellipsoid algorithm.

Typedef Documentation

ArrayType

template<typename T >

using ArrayType = typename T::ArrayType

Type alias for the array type used by template parameter T.

Template Parameters

T	The type containing ArrayType

CutChoice

template<typename T >

using CutChoice = typename T::CutChoice

Type alias for the cut choice type used by template parameter T.

Template Parameters

T	The type containing CutChoice

CutConcept

template<typename T >

using CutConcept = std::pair<ArrayType<T>, CutChoice<T> >

Type alias for a cutting plane concept.

Template Parameters

T	The template parameter type

RetQ

template<typename T >

using RetQ = std::tuple<CutConcept<T>, bool, ArrayType<T>, bool>

Type alias for return type of Q optimization.

Template Parameters

T	The template parameter type

SingleCut

using SingleCut = double

Single cut parameter β in gᵀ(x - xc) + β ≤ 0.

Represents the bias term in a cutting plane constraint.

In Rust this is a newtype: pub struct SingleCut(pub f64); In Python this is a type alias: SingleCut = float In C++ this is a type alias for consistency:

Enumeration Type Documentation

CutStatus

enum class CutStatus

strong

Status of cutting plane operations.

This enumeration represents the possible outcomes of cutting plane operations in the ellipsoid algorithm.

Enumerator
Success	Cut was successful and ellipsoid was updated.
NoSoln	No solution exists (infeasible)
NoEffect	Cut had no effect on ellipsoid.
Unknown	Unknown status.

Function Documentation

operator<<()

auto operator<< ( std::ostream &  os, CutStatus  s  ) -> std::ostream&

inline

Stream output operator for CutStatus.