Public Member Functions | Protected Member Functions | Private Attributes | List of all members
corbo::Range Class Reference

#include <range.h>

Public Member Functions

double getEnd () const
 
double getEndPlusEps () const
 
void getGrid (std::vector< double > &values)
 
void getGrid (std::vector< double > &values, double offset)
 
int getNumInRange () const
 
double getProgressFactor (double t) const
 
double getRemainder () const
 
double getStart () const
 
double getStep () const
 
bool includeEnd () const
 
void printGrid ()
 
 Range (double single_val, bool force_include_end=false)
 
 Range (double start, double step, double end, bool force_include_end=false)
 
 Range (double start, double step, int num, bool force_include_end=false)
 
 Range (const std::array< double, 3 > &interval, bool force_include_end=false)
 

Protected Member Functions

void update ()
 

Private Attributes

double _end
 
bool _include_end = false
 
int _n
 
double _remainder
 
double _start
 
double _step
 

Detailed Description

Definition at line 37 of file range.h.

Constructor & Destructor Documentation

◆ Range() [1/4]

corbo::Range::Range ( double  single_val,
bool  force_include_end = false 
)
inlineexplicit

Definition at line 40 of file range.h.

◆ Range() [2/4]

corbo::Range::Range ( double  start,
double  step,
double  end,
bool  force_include_end = false 
)
inlineexplicit

Definition at line 45 of file range.h.

◆ Range() [3/4]

corbo::Range::Range ( double  start,
double  step,
int  num,
bool  force_include_end = false 
)
inlineexplicit

Definition at line 50 of file range.h.

◆ Range() [4/4]

corbo::Range::Range ( const std::array< double, 3 > &  interval,
bool  force_include_end = false 
)
inlineexplicit

Definition at line 56 of file range.h.

Member Function Documentation

◆ getEnd()

double corbo::Range::getEnd ( ) const
inline

Definition at line 64 of file range.h.

◆ getEndPlusEps()

double corbo::Range::getEndPlusEps ( ) const
inline

Definition at line 68 of file range.h.

◆ getGrid() [1/2]

void corbo::Range::getGrid ( std::vector< double > &  values)
inline

Definition at line 75 of file range.h.

◆ getGrid() [2/2]

void corbo::Range::getGrid ( std::vector< double > &  values,
double  offset 
)
inline

Definition at line 82 of file range.h.

◆ getNumInRange()

int corbo::Range::getNumInRange ( ) const
inline

Definition at line 71 of file range.h.

◆ getProgressFactor()

double corbo::Range::getProgressFactor ( double  t) const
inline

Definition at line 73 of file range.h.

◆ getRemainder()

double corbo::Range::getRemainder ( ) const
inline

Definition at line 69 of file range.h.

◆ getStart()

double corbo::Range::getStart ( ) const
inline

Definition at line 62 of file range.h.

◆ getStep()

double corbo::Range::getStep ( ) const
inline

Definition at line 63 of file range.h.

◆ includeEnd()

bool corbo::Range::includeEnd ( ) const
inline

Definition at line 66 of file range.h.

◆ printGrid()

void corbo::Range::printGrid ( )
inline

Definition at line 89 of file range.h.

◆ update()

void corbo::Range::update ( )
inlineprotected

Definition at line 99 of file range.h.

Member Data Documentation

◆ _end

double corbo::Range::_end
private

Definition at line 114 of file range.h.

◆ _include_end

bool corbo::Range::_include_end = false
private

Definition at line 115 of file range.h.

◆ _n

int corbo::Range::_n
private

Definition at line 118 of file range.h.

◆ _remainder

double corbo::Range::_remainder
private

Definition at line 117 of file range.h.

◆ _start

double corbo::Range::_start
private

Definition at line 112 of file range.h.

◆ _step

double corbo::Range::_step
private

Definition at line 113 of file range.h.


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


control_box_rst
Author(s): Christoph Rösmann
autogenerated on Mon Feb 28 2022 22:08:03