Data::Set1d class reference
[Core module]

Declaration  

#include <Goptical/Data/Set1d>

namespace Goptical {
namespace Data {
class Set1d;
};
};

This class is a member of the Data namespace.

This abstract class contains pure virtuals.

Inheritance  


 
 

 
 


 
 

 
 


 
 

 
 
 


Description  

Base class for 1d y = f(x) numerical data set

Members  

See also the full member list section for this class.

Inherited members  

  • 12 members inherited from Set

Functions  

  • virtual ~Set1d()
  • virtual unsigned int get_count() const = 0;
  • virtual unsigned int get_count(unsigned int dim) const
  • virtual unsigned int get_dimensions() const
  • virtual Math::range_t get_x_range() const = 0;
  • virtual Math::range_t get_x_range(unsigned int dimension) const
  • virtual double get_x_value(unsigned int n) const = 0;
  • virtual double get_x_value(unsigned int n, unsigned int dim) const
  • virtual double get_y_value(unsigned int n) const = 0;
  • virtual double & get_y_value(unsigned int n) = 0;
  • virtual double get_y_value(const unsigned int x[]) const
  • virtual double interpolate(const double x) const = 0;
  • virtual double interpolate(const double x, unsigned int deriv) const = 0;
  • virtual double interpolate(const double x[]) const
  • virtual double interpolate(const double x[], unsigned int deriv, unsigned int dimension) const

Members detail  

virtual ~Set1d()  

No documentation available

virtual unsigned int get_count() const = 0;  

Get total number of data stored in data set

virtual unsigned int get_count(unsigned int dim) const  

This virtual function implements the get_count pure function declared in the Set base abstract class.

Documentation inherited from base class:

Get total number of data stored for dimension n in data set

virtual unsigned int get_dimensions() const  

This virtual function implements the get_dimensions pure function declared in the Set base abstract class.

Documentation inherited from base class:

Get total number of dimensions

virtual Math::range_t get_x_range() const = 0;  

Get minimal and maximal x values on found in data set

virtual Math::range_t get_x_range(unsigned int dimension) const  

This virtual function implements the get_x_range pure function declared in the Set base abstract class.

Documentation inherited from base class:

Get minimal and maximal x values on dimension n found in data set

virtual double get_x_value(unsigned int n) const = 0;  

Get x data at index n in data set

virtual double get_x_value(unsigned int n, unsigned int dim) const  

This virtual function implements the get_x_value pure function declared in the Set base abstract class.

Documentation inherited from base class:

Get data stored at position n on dimension dim in data set

virtual double get_y_value(unsigned int n) const = 0;  

Get y data stored at index n in data set

virtual double & get_y_value(unsigned int n) = 0;  

Get modifiable reference to y data stored at index n in data set

virtual double get_y_value(const unsigned int x[]) const  

This virtual function implements the get_y_value pure function declared in the Set base abstract class.

Documentation inherited from base class:

Get y data stored at position (x0, x1, ...) in data set

virtual double interpolate(const double x) const = 0;  

Interpolate y value corresponding to given x value in data set.

virtual double interpolate(const double x, unsigned int deriv) const = 0;  

Interpolate y value corresponding to given x value in data set. Data may be differentiated several times.

  • deriv: Differentiation count, 0 means y value, 1 means 1st derivative...

virtual double interpolate(const double x[]) const  

This virtual function implements the interpolate pure function declared in the Set base abstract class.

Documentation inherited from base class:

Interpolate y value corresponding to given x value(s) in data set.

virtual double interpolate(const double x[], unsigned int deriv, unsigned int dimension) const  

This virtual function implements the interpolate pure function declared in the Set base abstract class.

Documentation inherited from base class:

Interpolate y value corresponding to given x value in data set. Data may be differentiated several times along the requested dimension.

  • deriv: Differentiation count, 0 means y value, 1 means 1st derivative...
  • dim: Differentiation dimension

Valid XHTML 1.0 StrictGenerated by diaxen on Sun Jan 8 00:47:23 2012 using MkDoc