juce::dsp::Polynomial< FloatingType > Class Template Reference

A class representing a polynomial. More...

#include <juce_Polynomial.h>

Collaboration diagram for juce::dsp::Polynomial< FloatingType >:

Public Member Functions
	Polynomial ()
	Creates a new polynomial which will always evaluate to zero.
	Polynomial (const FloatingType *coefficients, int numCoefficients)
	Creates a new polynomial with given coefficients.
	Polynomial (const Polynomial &)=default
	Creates a copy of another polynomial.
	Polynomial (Polynomial &&)=default
	Creates a copy of another polynomial.
template<typename... Values>
	Polynomial (Values... items)
	Creates a new polynomial with coefficients by a C++11 initializer list.
int	getOrder () noexcept
	Returns the order of the polynomial.
Polynomial< FloatingType >	getProductWith (const Polynomial< FloatingType > &other) const
	computes the product of two polynomials and return the result
Polynomial< FloatingType >	getSumWith (const Polynomial< FloatingType > &other) const
	Returns the sum of this polynomial with another.
FloatingType	operator() (FloatingType x) const noexcept
	Evaluates the value of the polynomial at a single point x.
Polynomial &	operator= (const Polynomial &)=default
	Creates a copy of another polynomial.
Polynomial &	operator= (Polynomial &&)=default
	Creates a copy of another polynomial.
FloatingType	operator[] (int index) const noexcept
	Returns a single coefficient of the receiver for reading.
FloatingType &	operator[] (int index) noexcept
	Returns a single coefficient of the receiver for modifying.
Polynomial< FloatingType >	withGain (double gain) const
	Returns the polynomial with all its coefficients multiplied with a gain factor.

Private Attributes
Array< FloatingType >	coeffs

Detailed Description

template<typename FloatingType>
class juce::dsp::Polynomial< FloatingType >

A class representing a polynomial.

@tags{DSP}

Constructor & Destructor Documentation

Polynomial() [1/5]

template<typename FloatingType >

juce::dsp::Polynomial< FloatingType >::Polynomial ( )

inline

Creates a new polynomial which will always evaluate to zero.

References juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::add(), and juce::dsp::Polynomial< FloatingType >::coeffs.

Polynomial() [2/5]

template<typename FloatingType >

juce::dsp::Polynomial< FloatingType >::Polynomial ( const FloatingType *  coefficients, int  numCoefficients  )

inline

Creates a new polynomial with given coefficients.

Parameters

numCoefficients	The number of coefficients stored in coefficients. This is also the order of the returned polynomial.
coefficients	The coefficients which will be used by the newly created polynomial. The Polynomial class will keep a private copy of the coefficients.

References juce::dsp::Polynomial< FloatingType >::coeffs, juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::isEmpty(), and jassert.

Polynomial() [3/5]

template<typename FloatingType >

juce::dsp::Polynomial< FloatingType >::Polynomial ( const Polynomial< FloatingType > &  )

default

Creates a copy of another polynomial.

Polynomial() [4/5]

template<typename FloatingType >

juce::dsp::Polynomial< FloatingType >::Polynomial ( Polynomial< FloatingType > &&  )

default

Creates a copy of another polynomial.

Polynomial() [5/5]

template<typename FloatingType >

template<typename... Values>

juce::dsp::Polynomial< FloatingType >::Polynomial ( Values...  items )

inline

Creates a new polynomial with coefficients by a C++11 initializer list.

This function can be used in the following way: Polynomial<float> p ({0.5f, -0.3f, 0.2f});

References juce::dsp::Polynomial< FloatingType >::coeffs, juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::isEmpty(), and jassert.

Member Function Documentation

getOrder()

template<typename FloatingType >

int juce::dsp::Polynomial< FloatingType >::getOrder ( )

inlinenoexcept

Returns the order of the polynomial.

References juce::dsp::Polynomial< FloatingType >::coeffs, and juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::size().

getProductWith()

template<typename FloatingType >

Polynomial< FloatingType > juce::dsp::Polynomial< FloatingType >::getProductWith ( const Polynomial< FloatingType > &  other ) const

inline

computes the product of two polynomials and return the result

References juce::dsp::Polynomial< FloatingType >::coeffs, juce::jmax(), and juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::size().

getSumWith()

template<typename FloatingType >

Polynomial< FloatingType > juce::dsp::Polynomial< FloatingType >::getSumWith ( const Polynomial< FloatingType > &  other ) const

inline

Returns the sum of this polynomial with another.

References juce::dsp::Polynomial< FloatingType >::coeffs, juce::dsp::Polynomial< FloatingType >::getSumWith(), and juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::size().

Referenced by juce::dsp::Polynomial< FloatingType >::getSumWith().

operator()()

template<typename FloatingType >

FloatingType juce::dsp::Polynomial< FloatingType >::operator() ( FloatingType  x ) const

inlinenoexcept

Evaluates the value of the polynomial at a single point x.

References juce::dsp::Polynomial< FloatingType >::coeffs, juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::getUnchecked(), and juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::size().

operator=() [1/2]

template<typename FloatingType >

Polynomial & juce::dsp::Polynomial< FloatingType >::operator= ( const Polynomial< FloatingType > &  )

default

Creates a copy of another polynomial.

operator=() [2/2]

template<typename FloatingType >

Polynomial & juce::dsp::Polynomial< FloatingType >::operator= ( Polynomial< FloatingType > &&  )

default

Creates a copy of another polynomial.

operator[]() [1/2]

template<typename FloatingType >

FloatingType juce::dsp::Polynomial< FloatingType >::operator[] ( int  index ) const

inlinenoexcept

Returns a single coefficient of the receiver for reading.

References juce::dsp::Polynomial< FloatingType >::coeffs, and juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::getUnchecked().

operator[]() [2/2]

template<typename FloatingType >

FloatingType & juce::dsp::Polynomial< FloatingType >::operator[] ( int  index )

inlinenoexcept

Returns a single coefficient of the receiver for modifying.

References juce::dsp::Polynomial< FloatingType >::coeffs, and juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::getReference().

withGain()

template<typename FloatingType >

Polynomial< FloatingType > juce::dsp::Polynomial< FloatingType >::withGain ( double  gain ) const

inline

Returns the polynomial with all its coefficients multiplied with a gain factor.

Member Data Documentation

coeffs

template<typename FloatingType >

Array<FloatingType> juce::dsp::Polynomial< FloatingType >::coeffs

private

Referenced by juce::dsp::Polynomial< FloatingType >::Polynomial(), juce::dsp::Polynomial< FloatingType >::Polynomial(), juce::dsp::Polynomial< FloatingType >::Polynomial(), juce::dsp::Polynomial< FloatingType >::getOrder(), juce::dsp::Polynomial< FloatingType >::getProductWith(), juce::dsp::Polynomial< FloatingType >::getSumWith(), juce::dsp::Polynomial< FloatingType >::operator()(), juce::dsp::Polynomial< FloatingType >::operator[](), and juce::dsp::Polynomial< FloatingType >::operator[]().

---

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

• juce_Polynomial.h