Bayeux  3.4.1
Core Foundation library for SuperNEMO
Public Member Functions | Static Public Member Functions | Static Public Attributes | Friends | List of all members
mygsl::interval Class Reference

An interval with real bounds. More...

#include <bayeux/mygsl/interval.h>

Inheritance diagram for mygsl::interval:
datatools::i_serializable

Public Member Functions

 interval ()
 Default constructor. More...
 
 interval (double min_, double max_, double eps_=AUTO_EPS)
 Constructor. More...
 
 interval (double min_, bool min_include_, double max_, bool max_include_, double eps_=AUTO_EPS)
 Constructor. More...
 
virtual ~interval ()
 Destructor. More...
 
void remove_min ()
 
void remove_max ()
 
void reset ()
 
void set_min_included (bool inc_)
 
void set_max_included (bool inc_)
 
bool is_min_included () const
 
bool is_max_included () const
 
bool is_valid () const
 
bool has_min () const
 
bool has_max () const
 
double get_min () const
 
double get_max () const
 
double get_eps () const
 
bool union_with (const interval &)
 
bool intercept_with (const interval &)
 
bool is_in (double x_) const
 
bool is_in_safe (double x_) const
 
bool is_in_min_unsafe (double x_) const
 
bool is_in_max_unsafe (double x_) const
 
interval get_safe_interval (double eps_=AUTO_EPS) const
 
void set_eps (double eps_)
 
void set (double min_, double max_, double eps_=AUTO_EPS)
 
bool is_no_limit () const
 
bool is_empty () const
 
void open ()
 
void close ()
 
bool intersection_with (const interval &i_) const
 
- Public Member Functions inherited from datatools::i_serializable
 i_serializable ()
 Default constructor. More...
 
virtual ~i_serializable ()
 Destructor. More...
 
virtual const std::string & get_serial_tag () const =0
 Return the serialization string identifier of the class. More...
 

Static Public Member Functions

static interval make_empty ()
 
static interval make_no_limit (double eps_=AUTO_EPS)
 
static interval make_neighbourhood (double value_, double delta_, bool included_=excluded)
 
static interval make_min (double min_, bool min_include_=excluded, double eps_=AUTO_EPS)
 
static interval make_max (double max_, bool max_include_=excluded, double eps_=AUTO_EPS)
 
static interval make_min_max_included (double min_, double max_, double eps_=AUTO_EPS)
 
static interval make_min_max_excluded (double min_, double max_, double eps_=AUTO_EPS)
 
static interval make_min_max (double min_, bool min_include_, double max_, bool max_include_, double eps_=AUTO_EPS)
 

Static Public Attributes

static const double NO_MIN_VALUE
 
static const double NO_MAX_VALUE
 
static const double NO_VALUE
 
static const double DEFAULT_EPS
 
static const double AUTO_EPS
 
static const double auto_eps
 
static const char IO_SEP
 
static const char IO_EMPTY
 
static const char IO_OPEN_INCL
 
static const char IO_OPEN_EXCL
 
static const char IO_CLOSE_INCL
 
static const char IO_CLOSE_EXCL
 
static const bool included
 
static const bool excluded
 

Friends

std::ostream & operator<< (std::ostream &out_, const interval &i_)
 
std::istream & operator>> (std::istream &in_, interval &i_)
 

Detailed Description

An interval with real bounds.

Constructor & Destructor Documentation

◆ interval() [1/3]

mygsl::interval::interval ( )

Default constructor.

◆ interval() [2/3]

mygsl::interval::interval ( double  min_,
double  max_,
double  eps_ = AUTO_EPS 
)

Constructor.

◆ interval() [3/3]

mygsl::interval::interval ( double  min_,
bool  min_include_,
double  max_,
bool  max_include_,
double  eps_ = AUTO_EPS 
)

Constructor.

◆ ~interval()

virtual mygsl::interval::~interval ( )
virtual

Destructor.

Member Function Documentation

◆ close()

void mygsl::interval::close ( )

◆ get_eps()

double mygsl::interval::get_eps ( ) const

◆ get_max()

double mygsl::interval::get_max ( ) const

◆ get_min()

double mygsl::interval::get_min ( ) const

◆ get_safe_interval()

interval mygsl::interval::get_safe_interval ( double  eps_ = AUTO_EPS) const

◆ has_max()

bool mygsl::interval::has_max ( ) const

◆ has_min()

bool mygsl::interval::has_min ( ) const

◆ intercept_with()

bool mygsl::interval::intercept_with ( const interval )

◆ intersection_with()

bool mygsl::interval::intersection_with ( const interval i_) const

◆ is_empty()

bool mygsl::interval::is_empty ( ) const

◆ is_in()

bool mygsl::interval::is_in ( double  x_) const

◆ is_in_max_unsafe()

bool mygsl::interval::is_in_max_unsafe ( double  x_) const

◆ is_in_min_unsafe()

bool mygsl::interval::is_in_min_unsafe ( double  x_) const

◆ is_in_safe()

bool mygsl::interval::is_in_safe ( double  x_) const

◆ is_max_included()

bool mygsl::interval::is_max_included ( ) const

◆ is_min_included()

bool mygsl::interval::is_min_included ( ) const

◆ is_no_limit()

bool mygsl::interval::is_no_limit ( ) const

◆ is_valid()

bool mygsl::interval::is_valid ( ) const

◆ make_empty()

static interval mygsl::interval::make_empty ( )
static

◆ make_max()

static interval mygsl::interval::make_max ( double  max_,
bool  max_include_ = excluded,
double  eps_ = AUTO_EPS 
)
static

◆ make_min()

static interval mygsl::interval::make_min ( double  min_,
bool  min_include_ = excluded,
double  eps_ = AUTO_EPS 
)
static

◆ make_min_max()

static interval mygsl::interval::make_min_max ( double  min_,
bool  min_include_,
double  max_,
bool  max_include_,
double  eps_ = AUTO_EPS 
)
static

◆ make_min_max_excluded()

static interval mygsl::interval::make_min_max_excluded ( double  min_,
double  max_,
double  eps_ = AUTO_EPS 
)
static

◆ make_min_max_included()

static interval mygsl::interval::make_min_max_included ( double  min_,
double  max_,
double  eps_ = AUTO_EPS 
)
static

◆ make_neighbourhood()

static interval mygsl::interval::make_neighbourhood ( double  value_,
double  delta_,
bool  included_ = excluded 
)
static

◆ make_no_limit()

static interval mygsl::interval::make_no_limit ( double  eps_ = AUTO_EPS)
static

◆ open()

void mygsl::interval::open ( )

◆ remove_max()

void mygsl::interval::remove_max ( )

◆ remove_min()

void mygsl::interval::remove_min ( )

◆ reset()

void mygsl::interval::reset ( )

◆ set()

void mygsl::interval::set ( double  min_,
double  max_,
double  eps_ = AUTO_EPS 
)

◆ set_eps()

void mygsl::interval::set_eps ( double  eps_)

◆ set_max_included()

void mygsl::interval::set_max_included ( bool  inc_)

◆ set_min_included()

void mygsl::interval::set_min_included ( bool  inc_)

◆ union_with()

bool mygsl::interval::union_with ( const interval )

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  out_,
const interval i_ 
)
friend

◆ operator>>

std::istream& operator>> ( std::istream &  in_,
interval i_ 
)
friend

Member Data Documentation

◆ AUTO_EPS

const double mygsl::interval::AUTO_EPS
static

◆ auto_eps

const double mygsl::interval::auto_eps
static

◆ DEFAULT_EPS

const double mygsl::interval::DEFAULT_EPS
static

◆ excluded

const bool mygsl::interval::excluded
static

◆ included

const bool mygsl::interval::included
static

◆ IO_CLOSE_EXCL

const char mygsl::interval::IO_CLOSE_EXCL
static

◆ IO_CLOSE_INCL

const char mygsl::interval::IO_CLOSE_INCL
static

◆ IO_EMPTY

const char mygsl::interval::IO_EMPTY
static

◆ IO_OPEN_EXCL

const char mygsl::interval::IO_OPEN_EXCL
static

◆ IO_OPEN_INCL

const char mygsl::interval::IO_OPEN_INCL
static

◆ IO_SEP

const char mygsl::interval::IO_SEP
static

◆ NO_MAX_VALUE

const double mygsl::interval::NO_MAX_VALUE
static

◆ NO_MIN_VALUE

const double mygsl::interval::NO_MIN_VALUE
static

◆ NO_VALUE

const double mygsl::interval::NO_VALUE
static

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