itpp_sci  1.0.0
it++ based simulation framework for scicoslab, scilab and scipy
Public Member Functions | List of all members
SIM::amp Class Reference

gain block with offset
Core function SIM::amp.process()
More...

Inheritance diagram for SIM::amp:
Inheritance graph
[legend]

Public Member Functions

 amp ()
 
 ~amp ()
 
void set_gain (double g)
 
void set_offset (double o)
 
void set_output (double yout)
 
double get_gain (void)
 
double get_offset (void)
 
double get_output (void)
 
vec process (const bvec &ce, const vec &x)
 

Detailed Description

gain block with offset
Core function SIM::amp.process()

y = gain*x+offset
default gain = 1.0
default offset = 0.0

Constructor & Destructor Documentation

SIM::amp::amp ( )
inline
SIM::amp::~amp ( )
inline

Member Function Documentation

double SIM::amp::get_gain ( void  )

get gain

Returns
- [double] gain
double SIM::amp::get_offset ( void  )

get offset value

Returns
- [double] offset
double SIM::amp::get_output ( void  )

get output value y0

Returns
- [double] y0
vec SIM::amp::process ( const bvec &  ce,
const vec &  x 
)

process input samples - [x] for active clock ticks [ce]

Parameters
ce[bvec] clock_enable vector
x[vec] input vector
Returns
y [vec] output vector y = gain*x + offset
void SIM::amp::set_gain ( double  g)

set gain

Parameters
[in]g- [double] gain
void SIM::amp::set_offset ( double  o)

set offset

Parameters
[in]o- [double] offset
void SIM::amp::set_output ( double  yout)

set output value y0

Parameters
[in]yout- [double] => y0

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