GNU Radio Manual and C++ API Reference 3.8.5.0
The Free & Open Software Radio Ecosystem
 
Loading...
Searching...
No Matches
metrics.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2004,2012,2018 Free Software Foundation, Inc.
4 *
5 * This file is part of GNU Radio
6 *
7 * GNU Radio is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 3, or (at your option)
10 * any later version.
11 *
12 * GNU Radio is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with GNU Radio; see the file COPYING. If not, write to
19 * the Free Software Foundation, Inc., 51 Franklin Street,
20 * Boston, MA 02110-1301, USA.
21 */
22
23
24#ifndef METRICS_H
25#define METRICS_H
26
27#include <gnuradio/block.h>
30#include <cstdint>
31
32namespace gr {
33namespace trellis {
34
35/*!
36 * \brief Evaluate metrics for use by the Viterbi algorithm.
37 * \ingroup trellis_coding_blk
38 */
39template <class T>
40class TRELLIS_API metrics : virtual public block
41{
42public:
43 // gr::trellis::metrics::sptr
44 typedef boost::shared_ptr<metrics<T>> sptr;
45
46 static sptr
47 make(int O, int D, const std::vector<T>& TABLE, digital::trellis_metric_type_t TYPE);
48
49 virtual int O() const = 0;
50 virtual int D() const = 0;
52 virtual std::vector<T> TABLE() const = 0;
53
54 virtual void set_O(int O) = 0;
55 virtual void set_D(int D) = 0;
57 virtual void set_TABLE(const std::vector<T>& table) = 0;
58};
59
60
65} /* namespace trellis */
66} /* namespace gr */
67
68#endif /* METRICS_H */
The abstract base class for all 'terminal' processing blocks.
Definition block.h:72
Evaluate metrics for use by the Viterbi algorithm.
Definition metrics.h:41
virtual void set_TYPE(digital::trellis_metric_type_t type)=0
virtual std::vector< T > TABLE() const =0
virtual int D() const =0
virtual digital::trellis_metric_type_t TYPE() const =0
virtual int O() const =0
static sptr make(int O, int D, const std::vector< T > &TABLE, digital::trellis_metric_type_t TYPE)
virtual void set_TABLE(const std::vector< T > &table)=0
boost::shared_ptr< metrics< T > > sptr
Definition metrics.h:44
virtual void set_D(int D)=0
virtual void set_O(int O)=0
#define TRELLIS_API
Definition gr-trellis/include/gnuradio/trellis/api.h:30
trellis_metric_type_t
Definition metric_type.h:29
metrics< gr_complex > metrics_c
Definition metrics.h:64
metrics< std::int16_t > metrics_s
Definition metrics.h:61
metrics< float > metrics_f
Definition metrics.h:63
metrics< std::int32_t > metrics_i
Definition metrics.h:62
GNU Radio logging wrapper for log4cpp library (C++ port of log4j)
Definition basic_block.h:46