Spinning Topp Logo BlackTopp Studios
inc
Classes | Namespaces | Functions
interpolator.h File Reference

Helper classes to assist in generating data points between two other data points. More...

#include "datatypes.h"
#include "exception.h"
#include "cubicspline.h"
#include "serialization.h"
#include <cmath>
#include <iterator>
#include <iostream>
#include <typeinfo>
#include "XML/xml.h"
+ Include dependency graph for interpolator.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  Mezzanine::BezierInterpolator< T >
 A simple functor for interpolating data points in a simple way. More...
 
class  Mezzanine::LinearInterpolator< T >
 A simple functor for interpolating data points in a simple way. More...
 
class  Mezzanine::SlowSplineInterpolator< T >
 If something specifically needs the linear interpolator for T they should use this. More...
 
class  Mezzanine::TrackStorage< InterpolatableType, InterpolatorType >
 

Namespaces

 Mezzanine
 The bulk of the engine components go in this namspace.
 

Functions

template<typename T >
std::ostream & operator<< (std::ostream &stream, const Mezzanine::LinearInterpolator< T > &Lint)
 Used to Serialize an Mezzanine::LinearInterpolator to a human readable stream. More...
 
template<typename T >
std::ostream & operator<< (std::ostream &stream, const Mezzanine::BezierInterpolator< T > &Lint)
 Used to Serialize an Mezzanine::BezierInterpolator to a human readable stream. More...
 
template<typename T >
std::istream & operator>> (std::istream &stream, Mezzanine::LinearInterpolator< T > &Lint)
 Used to de-serialize an Mezzanine::LinearInterpolator from a stream. More...
 
template<typename T >
std::istream & operator>> (std::istream &stream, Mezzanine::BezierInterpolator< T > &Lint)
 Used to de-serialize an Mezzanine::BezierInterpolator from a stream. More...
 

Detailed Description

Helper classes to assist in generating data points between two other data points.

Definition in file interpolator.h.

Function Documentation

template<typename T >
std::ostream& operator<< ( std::ostream &  stream,
const Mezzanine::LinearInterpolator< T > &  Lint 
)

Used to Serialize an Mezzanine::LinearInterpolator to a human readable stream.

The current XML format is extremely simple because there no data: 'c'.

Parameters
LintThe Mezzanine::LinearInterpolator to be converted to characters.
streamThe place to send the characters, that define the Mezzanine::LinearInterpolator.
Returns
Get an std::ostream that was written to, this allow chaining of the << operators.

Definition at line 433 of file interpolator.h.

template<typename T >
std::ostream& operator<< ( std::ostream &  stream,
const Mezzanine::BezierInterpolator< T > &  Lint 
)

Used to Serialize an Mezzanine::BezierInterpolator to a human readable stream.

The current XML format is extremely simple because there no data: 'c'.

Parameters
LintThe Mezzanine::BezierInterpolator to be converted to characters.
streamThe place to send the characters, that define the Mezzanine::BezierInterpolator.
Returns
Get an std::ostream that was written to, this allow chaining of the << operators.

Definition at line 458 of file interpolator.h.

template<typename T >
std::istream& operator>> ( std::istream &  stream,
Mezzanine::LinearInterpolator< T > &  Lint 
)

Used to de-serialize an Mezzanine::LinearInterpolator from a stream.

This does primarily type checking most interpolators have no data

Parameters
LintThe Mezzanine::LinearInterpolator that will accept the values from the xml
streamThe place to get the characters from, that define the Mezzanine::LinearInterpolator.
Returns
Get an std::ostream that was read from, this allow chaining of the >> operators.
Exceptions
Canthrow any exception that any function in the Mezzanine::xml namespace could throw in addition to a Mezzanine::ExceptionBase if the serialization version doesn't match.

Definition at line 448 of file interpolator.h.

template<typename T >
std::istream& operator>> ( std::istream &  stream,
Mezzanine::BezierInterpolator< T > &  Lint 
)

Used to de-serialize an Mezzanine::BezierInterpolator from a stream.

This does primarily type checking most interpolators have no data

Parameters
LintThe Mezzanine::BezierInterpolator that will accept the values from the xml
streamThe place to get the characters from, that define the Mezzanine::BezierInterpolator.
Returns
Get an std::ostream that was read from, this allow chaining of the >> operators.
Exceptions
Canthrow any exception that any function in the Mezzanine::XML namespace could throw in addition to a Mezzanine::ExceptionBase if the serialization version doesn't match.

Definition at line 473 of file interpolator.h.