SinesCoefficients class allows to compute the coefficients of a sampled function using sines basis functions. More...

#include <STK_SinesCoefficients.h>

Inheritance diagram for STK::SinesCoefficients< Data, Coefs >:

Public Types
typedef IBasis< Data, Coefs >	Base

typedef Data::Type	Type

Public Types inherited from STK::IBasis< Data, Coefs >
typedef Data::Type	Type

Public Member Functions
	SinesCoefficients (Data const *p_data=0, int dim=1, bool useDataValues=true)
	default constructor

	SinesCoefficients (Data const &data, int dim, bool useDataValues=true)
	constructor

	SinesCoefficients (SinesCoefficients const &coefs)
	copy constructor.

virtual	~SinesCoefficients ()
	Destructor.

SinesCoefficients *	clone () const
	clone pattern implementation

virtual bool	run ()
	run the computations.

Public Member Functions inherited from STK::IBasis< Data, Coefs >
	IBasis ()
	default constructor

	IBasis (Data const *p_data, int dim, bool useDataValues=true)
	constructor

	IBasis (Data const &data, int dim, bool useDataValues=true)
	constructor

	IBasis (IBasis const &basis)
	copy constructor.

virtual	~IBasis ()
	destructor

int	dim () const

Coefs const &	coefficients () const

Type	minValue () const

Type	maxValue () const

void	setData (Data const &data)
	Set the data set.

void	setDim (int dim)

void	setMinValue (Type const &minValue)

void	setMaxValue (Type const &maxValue)

bool	initializeStep ()
	Initialize the parameters minValue_ and maxValue_ using data set.

Public Member Functions inherited from STK::IRunnerBase
String const &	error () const
	get the last error message.

Public Attributes
Data const *	p_data_
	the input data set

Coefs	coefficients_
	Array2D of the coefficients.

int	dim_
	number of dimension to build

Type	minValue_
	Minimal value of the data.

Type	maxValue_
	Maximal value of the data.

Additional Inherited Members
Protected Member Functions inherited from STK::IBasis< Data, Coefs >
virtual void	update ()
	update IBasis if a parameter or a new data set is set, update the state of this runner.

Protected Member Functions inherited from STK::IRunnerBase
	IRunnerBase ()
	default constructor

	IRunnerBase (IRunnerBase const &runner)
	copy constructor

virtual	~IRunnerBase ()
	destructor

Protected Attributes inherited from STK::IBasis< Data, Coefs >
Data const *	p_data_
	the input data set

int	dim_
	number of dimension to build

bool	useDataValues_

Type	minValue_
	Minimal value of the data.

Type	maxValue_
	Maximal value of the data.

Coefs	coefficients_
	Array2D of the coefficients.

Protected Attributes inherited from STK::IRunnerBase
String	msg_error_
	String with the last error message.

bool	hasRun_
	`true` if run has been used, `false` otherwise

Detailed Description

template<class Data, class Coefs = ArrayXX>
class STK::SinesCoefficients< Data, Coefs >

SinesCoefficients class allows to compute the coefficients of a sampled function using sines basis functions.

Definition at line 47 of file STK_SinesCoefficients.h.

Member Typedef Documentation

◆ Base

template<class Data , class Coefs = ArrayXX>

typedef IBasis<Data, Coefs> STK::SinesCoefficients< Data, Coefs >::Base

Definition at line 50 of file STK_SinesCoefficients.h.

◆ Type

template<class Data , class Coefs = ArrayXX>

typedef Data::Type STK::SinesCoefficients< Data, Coefs >::Type

Definition at line 51 of file STK_SinesCoefficients.h.

Constructor & Destructor Documentation

◆ SinesCoefficients() [1/3]

template<class Data , class Coefs = ArrayXX>

STK::SinesCoefficients< Data, Coefs >::SinesCoefficients	(	Data const *	p_data = `0`,
		int	dim = `1`,
		bool	useDataValues = `true`
	)

inline

default constructor

Parameters

p_data	pointer on the data set
dim	number of basis to use
useDataValues	if `true` use data in order to find the minValue_ and maxValue_, use values set otherwise.

Definition at line 67 of file STK_SinesCoefficients.h.

68 : Base(p_data, dim, useDataValues){}

STK::IBasis::dim

int dim() const

Definition STK_IBasis.h:77

STK::SinesCoefficients::Base

IBasis< Data, Coefs > Base

Definition STK_SinesCoefficients.h:50

◆ SinesCoefficients() [2/3]

template<class Data , class Coefs = ArrayXX>

STK::SinesCoefficients< Data, Coefs >::SinesCoefficients	(	Data const &	data,
		int	dim,
		bool	useDataValues = `true`
	)

inline

constructor

Parameters

data	reference on the data set
dim	number of basis to use
useDataValues	if `true` use data in order to find the minValue_ and maxValue_, use values set otherwise.

Definition at line 75 of file STK_SinesCoefficients.h.

76 : Base(data, dim, useDataValues){}

◆ SinesCoefficients() [3/3]

template<class Data , class Coefs = ArrayXX>

STK::SinesCoefficients< Data, Coefs >::SinesCoefficients ( SinesCoefficients< Data, Coefs > const & coefs )

inline

copy constructor.

Parameters

coefs the coefficients to copy

Definition at line 80 of file STK_SinesCoefficients.h.

80: Base(coefs){}

◆ ~SinesCoefficients()

template<class Data , class Coefs = ArrayXX>

virtual STK::SinesCoefficients< Data, Coefs >::~SinesCoefficients ( )

inlinevirtual

Destructor.

Definition at line 82 of file STK_SinesCoefficients.h.

82{}

Member Function Documentation

◆ clone()

template<class Data , class Coefs = ArrayXX>

SinesCoefficients * STK::SinesCoefficients< Data, Coefs >::clone ( ) const

inline

clone pattern implementation

Definition at line 84 of file STK_SinesCoefficients.h.

84{ return new SinesCoefficients(*this);}

STK::SinesCoefficients::SinesCoefficients

SinesCoefficients(Data const *p_data=0, int dim=1, bool useDataValues=true)

default constructor

Definition STK_SinesCoefficients.h:67

◆ run()

template<class Data , class Coefs >

bool STK::SinesCoefficients< Data, Coefs >::run ( )

virtual

run the computations.

Implements STK::IRunnerBase.

Definition at line 91 of file STK_SinesCoefficients.h.

{
  // check if data exists
  if (!p_data_)
  {
   msg_error_ = STKERROR_NO_ARG(Error in SinesCoefficients::run,p_data_ is null);
   return false;
  }
  if (!this->initializeStep()) return false;
  if (dim_>1)
  {
    coefficients_.col(0) = Type(1);
    Type period = Type(2)*Const::_PI_/(maxValue_ - minValue_);
    for(int j=1; j<coefficients_.endCols(); ++j)
    {
      coefficients_.col(j) = (*p_data_ * Type(j)*period).sin();
    }
  }
  this->hasRun_ = true;
  return true;
 
}

References STK::IRunnerBase::hasRun_, STK::IRegression< Array, Array, Weight >::initializeStep(), STK::IRunnerBase::msg_error_, STK::SinesCoefficients< Data, Coefs >::run(), and STKERROR_NO_ARG.

Referenced by STK::ChebyshevCoefficients< Data, Coefs >::run(), and STK::SinesCoefficients< Data, Coefs >::run().

Member Data Documentation

◆ coefficients_

template<class Data , class Coefs = ArrayXX>

Coefs STK::IBasis< Data, Coefs >::coefficients_

Array2D of the coefficients.

Definition at line 121 of file STK_IBasis.h.

◆ dim_

template<class Data , class Coefs = ArrayXX>

int STK::IBasis< Data, Coefs >::dim_

number of dimension to build

Definition at line 112 of file STK_IBasis.h.

◆ maxValue_

template<class Data , class Coefs = ArrayXX>

Type STK::IBasis< Data, Coefs >::maxValue_

Maximal value of the data.

Definition at line 118 of file STK_IBasis.h.

◆ minValue_

template<class Data , class Coefs = ArrayXX>

Type STK::IBasis< Data, Coefs >::minValue_

Minimal value of the data.

Definition at line 116 of file STK_IBasis.h.

◆ p_data_

template<class Data , class Coefs = ArrayXX>

Data const* STK::IBasis< Data, Coefs >::p_data_

the input data set

Definition at line 110 of file STK_IBasis.h.

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

STK_SinesCoefficients.h

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Base

◆ Type

Constructor & Destructor Documentation

◆ SinesCoefficients() [1/3]

◆ SinesCoefficients() [2/3]

◆ SinesCoefficients() [3/3]

◆ ~SinesCoefficients()

Member Function Documentation

◆ clone()

◆ run()

Member Data Documentation

◆ coefficients_

◆ dim_

◆ maxValue_

◆ minValue_

◆ p_data_