Molassembler  3.0.0
Molecule graph and conformer library
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Scine::Molassembler::DistanceGeometry::ValueBounds Struct Reference

Data class for bounded values. More...

#include <ValueBounds.h>

Public Member Functions

constexpr ValueBounds (double passLower, double passUpper)
 Main constructor. More...
 
 ValueBounds ()
 Default constructor yields double lowest/max pair. More...
 
bool operator== (const ValueBounds &other) const
 Returns whether the bounds exactly equal another set of bounds. More...
 
bool operator!= (const ValueBounds &other) const
 Negates operator ==.
 

Data Fields

double lower
 
double upper
 

Detailed Description

Data class for bounded values.

Constructor & Destructor Documentation

constexpr Scine::Molassembler::DistanceGeometry::ValueBounds::ValueBounds ( double  passLower,
double  passUpper 
)
inline

Main constructor.

Complexity \(\Theta(1)\)

Parameters
passLowerLower end of the value boundaries
passUpperUpper end of the value boundaries
Exceptions
std::runtime_errorIf the upper value is smaller than the lower. Equalities are allowed.
Returns
A ValueBounds instance with the specified bounds
Scine::Molassembler::DistanceGeometry::ValueBounds::ValueBounds ( )

Default constructor yields double lowest/max pair.

Complexity \(\Theta(1)\)

Returns
lowest/max bounds from numeric_limits

Member Function Documentation

bool Scine::Molassembler::DistanceGeometry::ValueBounds::operator== ( const ValueBounds other) const

Returns whether the bounds exactly equal another set of bounds.

Complexity \(\Theta(1)\)

Parameters
otherThe other bounds to compare against
Returns
If the bounds exactly equal one another

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