Jamoma API  0.6.0.a19
TTTanhFunction.h
Go to the documentation of this file.
1 /** @file
2  *
3  * @ingroup dspFunctionLib
4  *
5  * @brief #TTTanhFunction Unit for Jamoms DSP
6  *
7  * @details
8  *
9  * @authors Trond Lossius
10  *
11  * @copyright Copyright © 2007 by Trond Lossius @n
12  * This code is licensed under the terms of the "New BSD License" @n
13  * http://creativecommons.org/licenses/BSD/
14  */
15 
16 
17 #ifndef __TANHFUNCTION_H__
18 #define __TANHFUNCTION_H__
19 
20 #include "TTDSP.h"
21 
22 
23 /** A function unit providing a curve based on
24  y = tanh(x)
25  but with a variety of additions to the basic trig function.
26  */
29 
30 protected:
31 
32  TTFloat64 mWidth; ///< Parameter for function: y pow(x,pow(2,powerValue))
33  TTFloat64 mOffset; ///< k = pow(2,powerValue)
34  double a; ///< Internal coefficient
35  double b; ///< Internal coefficient
36  double alpha; ///< Internal coefficient
37  double beta; ///< Internal coefficient
38 
39  /** Calculate coefficients */
40  void calculateOutputScaling(void);
41 
42  /** Calculate coefficients when this attr is set */
43  TTErr setWidth(const TTValue& value);
44 
45  /** Calculate coefficients when this attr is set */
46  TTErr setOffset(const TTValue& value);
47 
48  /** y = f(x) for a single value */
49  inline TTErr calculateValue(const TTFloat64& x, TTFloat64& y, TTPtrSizedInt data);
50 
51  /** A standard audio processing method as used by TTBlue objects.*/
53 
54  /** Unit Tests */
55  virtual TTErr test(TTValue& returnedTestInfo);
56 
57 };
58 
59 
60 #endif // __TANHFUNCTION_H__
virtual TTErr test(TTValue &returnedTestInfo)
Unit Tests.
TTFloat64 mWidth
Parameter for function: y pow(x,pow(2,powerValue))
TTAudioObjectBase is the base class for all audio generating and processing objects in Jamoma DSP...
double b
Internal coefficient.
void calculateOutputScaling(void)
Calculate coefficients.
Jamoma DSP Library.
double TTFloat64
64 bit floating point number
Definition: TTBase.h:188
double a
Internal coefficient.
#define TTCLASS_SETUP(className)
TODO Doxygen: need more comments here.
Definition: TTFoundation.h:54
TTErr calculateValue(const TTFloat64 &x, TTFloat64 &y, TTPtrSizedInt data)
y = f(x) for a single value
TTErr setOffset(const TTValue &value)
Calculate coefficients when this attr is set.
A simple container for an array of TTAudioSignal pointers.
TTErr setWidth(const TTValue &value)
Calculate coefficients when this attr is set.
long TTPtrSizedInt
An integer that is the same size as a pointer.
Definition: TTBase.h:240
TTErr
Jamoma Error Codes Enumeration of error codes that might be returned by any of the TTBlue functions a...
Definition: TTBase.h:342
TTErr processAudio(TTAudioSignalArrayPtr inputs, TTAudioSignalArrayPtr outputs)
A standard audio processing method as used by TTBlue objects.
TTFloat64 mOffset
k = pow(2,powerValue)
double beta
Internal coefficient.
A function unit providing a curve based on y = tanh(x) but with a variety of additions to the basic t...
[doxygenAppendixC_copyExample]
Definition: TTValue.h:34
double alpha
Internal coefficient.