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

linear shift register - wrapper for a SIM::lsr
Core function: SCI::sci_lsr.proc() More...

Inheritance diagram for SCI::sci_lsr:
Inheritance graph
[legend]

Public Member Functions

 sci_lsr ()
 
 ~sci_lsr ()
 
sci_lsrcreate (int sci_type)
 
void destroy ()
 destroy SCI object More...
 
void set (int param, sci_var *p_v)
 
sci_varget (int param)
 
void exec (int command)
 
sci_varproc (sci_var *p_v_ce, sci_var *p_v_x)
 
- Public Member Functions inherited from SCI::sci_base
 sci_base ()
 constructor More...
 
virtual ~sci_base ()
 virtual destructor More...
 
sci_basecreate (int sci_type)
 creates SCI object and returns pointer to it More...
 
virtual sci_vargen (sci_var *p_v_ce)
 generate data using a SCI object More...
 
- Public Member Functions inherited from SIM::lsr
 lsr ()
 
 ~lsr ()
 
void set_length (int L)
 
void set_symbol_size (int W)
 
void set_reset_state (const bvec &binit)
 
void set_output (const bvec &yout)
 
void set_state (const bvec &state)
 
bvec get_state (void)
 
bvec get_reset_state ()
 
bvec get_output ()
 
int get_length (void)
 
int get_symbol_size ()
 
bmat process (const bvec &ce, const bmat &x)
 

Detailed Description

linear shift register - wrapper for a SIM::lsr
Core function: SCI::sci_lsr.proc()

Constructor & Destructor Documentation

SCI::sci_lsr::sci_lsr ( )
SCI::sci_lsr::~sci_lsr ( )

Member Function Documentation

sci_lsr* SCI::sci_lsr::create ( int  sci_type)
inline
void SCI::sci_lsr::destroy ( )
inlinevirtual

destroy SCI object

Reimplemented from SCI::sci_base.

void SCI::sci_lsr::exec ( int  command)
virtual

execute command for an instance of a LSR

Supported commands:
SCI_RESET 
Parameters
[in]command- to be executed

Reimplemented from SCI::sci_base.

sci_var * SCI::sci_lsr::get ( int  param)
virtual

create new sci_var object and assign its value to LSR parameter

Supported parameters:
SCI_TYPE,    sci_var [int]
SCI_LENGTH, sci_var [int]
SCI_SYMBOL_SIZE, sci_var [int]
SCI_STATE, sci_var [bvec]
SCI_RESET_STATE, sci_var [bvec]
SCI_OUTPUT, sci_var [bvec]
Note
SCI_SIZE <==> SCI_LENGHT
Parameters
[in]param- parameter to get

Reimplemented from SCI::sci_base.

sci_var * SCI::sci_lsr::proc ( sci_var p_v_ce,
sci_var p_v_x 
)
virtual

for active [ce] ticks, shift in x[i,:] symbol and shift out y[i,:] symbol

Note
symbols x[i,:], y[i,:] are rows in input/output bmat
for ce[N] and symbol_size W, input/output matrix have size x[N,W], y[N,W]
Parameters
[in]p_v_ce- pointer to ce - sci_var [bvec]
[in]p_v_x- pointer to x - sci_var [bmat]
Returns
- pointer to y - new sci_var [bmat]

Reimplemented from SCI::sci_base.

void SCI::sci_lsr::set ( int  param,
sci_var p_v 
)
virtual

set parameters of a LSR

Supported parameters:
SCI_LENGTH,  sci_var [int]
SCI_SYMBOL_SIZE, sci_var [int]
SCI_STATE, sci_var [bvec]
SCI_RESET_STATE, sci_var [bvec]
SCI_OUTPUT, sci_var [bvec]
Note
SCI_SIZE <==> SCI_LENGHT
SET SCI_SIZE or SCI_LENGHT and SCI_SYMBOL_SIZE are necessary configuration
Parameters
[in]param- parameter to set
[in]p_v- pointer to sci_var object with value of the parameter

Reimplemented from SCI::sci_base.


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