BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
IAxis Class Referenceabstract

Interface for one-dimensional axes. More...

+ Inheritance diagram for IAxis:

Public Member Functions

 IAxis (const std::string &name)
 constructors
 
virtual IAxisclone () const =0
 clone function
 
virtual ~IAxis ()
 destructor
 
virtual size_t size () const =0
 retrieve the number of bins
 
std::string getName () const
 retrieve the label of the axis
 
void setName (std::string name)
 Sets the axis label.
 
virtual double operator[] (size_t index) const =0
 indexed accessor retrieves a sample
 
virtual Bin1D getBin (size_t index) const =0
 retrieve a 1d bin for the given index
 
virtual double getMin () const =0
 Returns value of first point of axis.
 
virtual double getMax () const =0
 Returns value of last point of axis.
 
virtual double getBinCenter (size_t index) const =0
 
virtual size_t findClosestIndex (double value) const =0
 find bin index which is best match for given value
 
bool operator== (const IAxis &right) const
 test for equality
 
bool operator!= (const IAxis &right) const
 
virtual std::vector< double > getBinCenters () const
 
virtual std::vector< double > getBinBoundaries () const
 
virtual IAxiscreateClippedAxis (double left, double right) const
 Creates a new clipped axis.
 
virtual bool contains (double value) const
 Returns true if axis contains given point.
 
virtual std::string pyString (const std::string &units, size_t offset) const =0
 

Protected Member Functions

virtual void print (std::ostream &ostr) const =0
 
virtual bool equals (const IAxis &other) const
 

Friends

std::ostream & operator<< (std::ostream &ostr, const IAxis &m)
 

Detailed Description

Interface for one-dimensional axes.

Definition at line 24 of file IAxis.h.


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