BALL::PiecewiseFunction Class Reference

#include <BALL/MATHS/piecewiseFunction.h>

Inheritance diagram for BALL::PiecewiseFunction:

Public Member Functions
Constructors and Destructors
	PiecewiseFunction ()
	PiecewiseFunction (const PiecewiseFunction &function)
	PiecewiseFunction (const std::vector< Interval > &intervals, const std::vector< Coefficients > &coeffs)
virtual	~PiecewiseFunction ()
Assignment
PiecewiseFunction &	operator= (const PiecewiseFunction &function)
void	clear ()
Accessors
void	setIntervals (const std::vector< Interval > &intervals)
const std::vector< Interval > &	getIntervals () const
const Interval &	getInterval (double x) const
const Interval &	getInterval (Position index) const
Position	getIntervalIndex (double x) const
const Interval &	getRange () const
void	setCoefficients (const vector< Coefficients > &coefficients)
const std::vector< Coefficients > &	getCoefficients () const
const Coefficients &	getCoefficients (double x) const
const Coefficients &	getCoefficients (Position index) const
virtual double	operator() (double x) const
void	set (const std::vector< Interval > &intervals, const std::vector< Coefficients > &coeffs)
Predicates
bool	isInRange (double x) const
virtual bool	isValid () const
bool	operator== (const PiecewiseFunction &function) const
Debugging and Diagnostics
virtual void	dump (std::ostream &s=std::cout, Size depth=0) const

Protected Attributes
std::vector< Interval >	intervals_
std::vector< Coefficients >	coefficients_
bool	valid_

Detailed Description

Piecewise function object. This class provides the interface for piecewise functions needed as representation of radial distribution functions (

See also

RadialDistributionFunction). It implements the Function interface.

Note that intervals must be disjunct and interval limits have to meet. We require the intervals to be sorted such that the lowest interval limit is the first interval of the vector.

Definition at line 34 of file piecewiseFunction.h.

Constructor & Destructor Documentation

BALL::PiecewiseFunction::PiecewiseFunction

(

)

Default constructor

BALL::PiecewiseFunction::PiecewiseFunction

(

const PiecewiseFunction &

function

)

Copy constructor

BALL::PiecewiseFunction::PiecewiseFunction	(	const std::vector< Interval > &	intervals,
		const std::vector< Coefficients > &	coeffs
	)

Detailed constructor

virtual BALL::PiecewiseFunction::~PiecewiseFunction ( )

virtual

Destructor

Member Function Documentation

void BALL::PiecewiseFunction::clear

(

)

Clear function

virtual void BALL::PiecewiseFunction::dump ( std::ostream &  s = std::cout, Size  depth = 0  ) const

virtual

Dumps the whole content of the object

Reimplemented in BALL::PiecewisePolynomial.

const std::vector<Coefficients>& BALL::PiecewiseFunction::getCoefficients

(

)

const

const Coefficients& BALL::PiecewiseFunction::getCoefficients

(

double

x

)

const

Get the coefficients for a given x

Exceptions

Exception::OutOfRange

if x is out of range

const Coefficients& BALL::PiecewiseFunction::getCoefficients

(

Position

index

)

const

Get the coefficients from index

Exceptions

Exception::IndexOverflow

if index >= intervals_.size()

const Interval& BALL::PiecewiseFunction::getInterval

(

double

x

)

const

Get the interval a given x belongs to

Exceptions

Exception::OutOfRange

if x is out of range

const Interval& BALL::PiecewiseFunction::getInterval

(

Position

index

)

const

Get interval limits by index

Exceptions

Exception::IndexOverflow

if index >= intervals_.size()

Position BALL::PiecewiseFunction::getIntervalIndex

(

double

x

)

const

Get the interval index for a given x

Exceptions

Exception::OutOfRange

if x is out of range

const std::vector<Interval>& BALL::PiecewiseFunction::getIntervals

(

)

const

Get all the intervals

const Interval& BALL::PiecewiseFunction::getRange

(

)

const

Return the range of the definition

bool BALL::PiecewiseFunction::isInRange

(

double

x

)

const

Check whether a given x is in the range of definition

virtual bool BALL::PiecewiseFunction::isValid ( ) const

virtual

check validity of the definition

virtual double BALL::PiecewiseFunction::operator() ( double  x ) const

virtual

compute the value of the piecewise function data for a given x

Reimplemented in BALL::PiecewisePolynomial.

PiecewiseFunction& BALL::PiecewiseFunction::operator=

(

const PiecewiseFunction &

function

)

Assignemnt operator

bool BALL::PiecewiseFunction::operator==

(

const PiecewiseFunction &

function

)

const

Equality operator

void BALL::PiecewiseFunction::set	(	const std::vector< Interval > &	intervals,
		const std::vector< Coefficients > &	coeffs
	)

void BALL::PiecewiseFunction::setCoefficients

(

const vector< Coefficients > &

coefficients

)

Set the coefficients. Note that this method does not check the vector of coefficients for sanity.

void BALL::PiecewiseFunction::setIntervals

(

const std::vector< Interval > &

intervals

)

Set the intervals for the piecewise definition. Note that this method does not check the definition of the intervals for sanity.

Member Data Documentation

std::vector<Coefficients> BALL::PiecewiseFunction::coefficients_

protected

Definition at line 171 of file piecewiseFunction.h.

std::vector<Interval> BALL::PiecewiseFunction::intervals_

protected

Definition at line 167 of file piecewiseFunction.h.

bool BALL::PiecewiseFunction::valid_

protected

Definition at line 173 of file piecewiseFunction.h.