LMMS
Loading...
Searching...
No Matches
juce::dsp::Polynomial< FloatingType > Class Template Reference

#include <juce_Polynomial.h>

Public Member Functions

 Polynomial ()
 Polynomial (const FloatingType *coefficients, int numCoefficients)
 Polynomial (const Polynomial &)=default
 Polynomial (Polynomial &&)=default
Polynomialoperator= (const Polynomial &)=default
Polynomialoperator= (Polynomial &&)=default
template<typename... Values>
 Polynomial (Values... items)
FloatingType operator[] (int index) const noexcept
FloatingType & operator[] (int index) noexcept
FloatingType operator() (FloatingType x) const noexcept
int getOrder () noexcept
Polynomial< FloatingType > withGain (double gain) const
Polynomial< FloatingType > getSumWith (const Polynomial< FloatingType > &other) const
Polynomial< FloatingType > getProductWith (const Polynomial< FloatingType > &other) const

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.

◆ 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
numCoefficientsThe number of coefficients stored in coefficients. This is also the order of the returned polynomial.
coefficientsThe coefficients which will be used by the newly created polynomial. The Polynomial class will keep a private copy of the coefficients.

◆ 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});

Member Function Documentation

◆ getOrder()

template<typename FloatingType>
int juce::dsp::Polynomial< FloatingType >::getOrder ( )
inlinenoexcept

Returns the order of the polynomial.

◆ 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

◆ 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

◆ 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.

◆ 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

◆ operator[]() [2/2]

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

Returns a single coefficient of the receiver for modifying.

◆ 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

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