ell1d Class Reference

Ellipsoid Method for special 1D case. More...

#include <ell1d.hpp>

Public Types
using	ArrayType = double

Public Member Functions
	~ell1d ()=default
ell1d &	operator= (const ell1d &)=default
	ell1d (ell1d &&) noexcept=default
ell1d &	operator= (ell1d &&) noexcept=default
	ell1d (const double l, const double u) noexcept
	Construct a new ell1d object.
	ell1d (const ell1d &E)=default
	Construct a new ell1d object.
auto	xc () const noexcept -> double
	Get the center of the ellipsoid.
auto	set_xc (const double xc) noexcept -> void
	Set the xc object.
constexpr auto	tsq () const -> double
	Get the squared radius of the ellipsoid.
auto	update (const std::pair< double, double > &cut) noexcept -> CutStatus
	Update the 1D ellipsoid using a deep cut.
auto	update_central_cut (const std::pair< double, double > &cut) noexcept -> CutStatus
	Update the 1D ellipsoid using a central cut.

Detailed Description

Ellipsoid Method for special 1D case.

Member Typedef Documentation

ArrayType

using ell1d::ArrayType = double

Constructor & Destructor Documentation

~ell1d()

ell1d::~ell1d ( )

default

ell1d() [1/3]

ell1d::ell1d ( ell1d &&  )

defaultnoexcept

ell1d() [2/3]

ell1d::ell1d ( const double  l, const double  u  )

inlinenoexcept

Construct a new ell1d object.

Parameters

[in]	l
[in]	u

ell1d() [3/3]

ell1d::ell1d ( const ell1d &  E )

explicitdefault

Construct a new ell1d object.

Parameters

[in]

E

Member Function Documentation

operator=() [1/2]

ell1d & ell1d::operator= ( const ell1d &  )

default

operator=() [2/2]

ell1d & ell1d::operator= ( ell1d &&  )

defaultnoexcept

set_xc()

auto ell1d::set_xc ( const double  xc ) -> void

inlinenoexcept

Set the xc object.

Parameters

[in]

xc

tsq()

constexpr auto ell1d::tsq ( ) const -> double

inlineconstexpr

Get the squared radius of the ellipsoid.

Returns

double The squared radius.

update()

auto ell1d::update ( const std::pair< double, double > &  cut ) -> CutStatus

noexcept

Update the 1D ellipsoid using a deep cut.

\[ g (x - x_c) + \beta \le 0 \]

Parameters

[in]

cut

A pair containing (gradient, beta) representing the cut

Returns

CutStatus The status of the cut operation

update_central_cut()

auto ell1d::update_central_cut ( const std::pair< double, double > &  cut ) -> CutStatus

noexcept

Update the 1D ellipsoid using a central cut.

\[ g (x - x_c) \le 0 \]

Parameters

[in]

cut

A pair containing (gradient, beta) representing the cut

Returns

CutStatus The status of the cut operation

xc()

auto ell1d::xc ( ) const -> double

inlinenoexcept

Get the center of the ellipsoid.

Returns

double The center of the ellipsoid.

---

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

• ellalgo/ell1d.hpp