MAiNGO
babBase::Bounds Struct Reference

Auxiliary struct for representing bounds on an optimization variable. More...

#include <babOptVar.h>

Public Member Functions

 Bounds (const double lowerIn, const double upperIn)
 Constructor, checks that specified lower bound is smaller than upper bound (this information is only stored, but not acted upon) More...
 
 Bounds (Bounds &&)=default
 
 Bounds (const Bounds &)=default
 

Public Attributes

const double lower
 
const double upper
 
const double consistent
 

Private Member Functions

Boundsoperator= (const Bounds &)
 

Friends

std::ostream & operator<< (std::ostream &os, Bounds const &b)
 Overloaded outstream operator for nicer output. More...
 

Detailed Description

Auxiliary struct for representing bounds on an optimization variable.

This struct is only used to initialize optimization variables

Constructor & Destructor Documentation

◆ Bounds() [1/3]

babBase::Bounds::Bounds ( const double  lowerIn,
const double  upperIn 
)
inline

Constructor, checks that specified lower bound is smaller than upper bound (this information is only stored, but not acted upon)

Parameters
[in]lowerInis the specified lower bound on the optimization variable
[in]upperInis the specified upper bound on the optimization variable

◆ Bounds() [2/3]

babBase::Bounds::Bounds ( Bounds &&  )
default

Default copy constructor

◆ Bounds() [3/3]

babBase::Bounds::Bounds ( const Bounds )
default

Default copy constructor

Member Function Documentation

◆ operator=()

Bounds& babBase::Bounds::operator= ( const Bounds )
private

default assignment operator declared private to prevent use

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  os,
Bounds const &  b 
)
friend

Overloaded outstream operator for nicer output.

Parameters
[out]osis the outstream to be written to
[in]bare the bounds to be written

Member Data Documentation

◆ consistent

const double babBase::Bounds::consistent

Flag indicating whether the bounds are consisten (i.e., lower<=upper)

◆ lower

const double babBase::Bounds::lower

Lower bound on the optimization variable

◆ upper

const double babBase::Bounds::upper

Upper bound on the optimization variable


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