trellis_metrics_f Class Reference
[Signal Processing Blocks]

Evaluate metrics for use by the Viterbi algorithm. More...

#include <trellis_metrics_f.h>

Inheritance diagram for trellis_metrics_f:

[legend]

Collaboration diagram for trellis_metrics_f:

[legend]

List of all members.

Public Member Functions
int	O () const
int	D () const
trellis_metric_type_t	TYPE () const
std::vector< float >	TABLE () const
void	forecast (int noutput_items, gr_vector_int &ninput_items_required)
	Estimate input requirements given output request.
int	general_work (int noutput_items, gr_vector_int &ninput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)
	compute output items from input items
Friends
trellis_metrics_f_sptr	trellis_make_metrics_f (int O, int D, const std::vector< float > &TABLE, trellis_metric_type_t TYPE)

---

Detailed Description

Evaluate metrics for use by the Viterbi algorithm.

---

Member Function Documentation

int trellis_metrics_f::D

(

)

const [inline]

void trellis_metrics_f::forecast	(	int	noutput_items,
		gr_vector_int &	ninput_items_required
	)			[virtual]

Estimate input requirements given output request.

Parameters:

	noutput_items	number of output items to produce
	ninput_items_required	number of input items required on each input stream

Given a request to product noutput_items, estimate the number of data items required on each input stream. The estimate doesn't have to be exact, but should be close.

Reimplemented from gr_block.

int trellis_metrics_f::general_work	(	int	noutput_items,
		gr_vector_int &	ninput_items,
		gr_vector_const_void_star &	input_items,
		gr_vector_void_star &	output_items
	)			[virtual]

compute output items from input items

Parameters:

	noutput_items	number of output items to write on each output stream
	ninput_items	number of input items available on each input stream
	input_items	vector of pointers to the input items, one entry per input stream
	output_items	vector of pointers to the output items, one entry per output stream

Returns:

number of items actually written to each output stream, or -1 on EOF. It is OK to return a value less than noutput_items. -1 <= return value <= noutput_items

general_work must call consume or consume_each to indicate how many items were consumed on each input stream.

Implements gr_block.

int trellis_metrics_f::O

(

)

const [inline]

std::vector<float> trellis_metrics_f::TABLE

(

)

const [inline]

trellis_metric_type_t trellis_metrics_f::TYPE

(

)

const [inline]

---

Friends And Related Function Documentation

trellis_metrics_f_sptr trellis_make_metrics_f	(	int	O,
		int	D,
		const std::vector< float > &	TABLE,
		trellis_metric_type_t	TYPE
	)			[friend]

---

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

• trellis_metrics_f.h