dab_sum_elements_vff.h
Go to the documentation of this file.
/* -*- c++ -*- */
/*
* Copyright 2004 Free Software Foundation, Inc.
*
* This file is part of GNU Radio
*
* GNU Radio is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3, or (at your option)
* any later version.
*
* GNU Radio is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with GNU Radio; see the file COPYING. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street,
* Boston, MA 02110-1301, USA.
*/
#ifndef INCLUDED_DAB_SUM_ELEMENTS_VFF_H
#define INCLUDED_DAB_SUM_ELEMENTS_VFF_H
#include <gr_sync_block.h>
class dab_sum_elements_vff;
/*
* We use std::shared_ptr's instead of raw pointers for all access
* to gr_blocks (and many other data structures). The shared_ptr gets
* us transparent reference counting, which greatly simplifies storage
* management issues. This is especially helpful in our hybrid
* C++ / Python system.
*
* See http://www.boost.org/libs/smart_ptr/smart_ptr.htm
*
* As a convention, the _sptr suffix indicates a std::shared_ptr
*/
typedef std::shared_ptr<dab_sum_elements_vff> dab_sum_elements_vff_sptr;
/*!
* \brief Return a shared_ptr to a new instance of dab_sum_elements_vff.
*
* To avoid accidental use of raw pointers, dab_sum_elements_vff's
* constructor is private. dab_make_sum_elements_vff is the public
* interface for creating new instances.
*/
dab_sum_elements_vff_sptr
dab_make_sum_elements_vff (unsigned int length);
/*!
* \brief Sum up all elements of a vector
* \ingroup math
* \param length length of the vector
* \return \f[ y[k] = \sum_{i=1}^n x_i[k]\f]
*
* input: float vector
* output: float
*/
class dab_sum_elements_vff : public gr_sync_block
{
private:
// The friend declaration allows dab_make_sum_elements_vff to
// access the private constructor.
friend dab_sum_elements_vff_sptr
dab_make_sum_elements_vff (unsigned int length);
dab_sum_elements_vff (unsigned int length); // private constructor
unsigned int d_length;
public:
int work (int noutput_items,
gr_vector_const_void_star &input_items,
gr_vector_void_star &output_items);
};
#endif /* INCLUDED_DAB_SUM_ELEMENTS_VFF_H */
dab_sum_elements_vff
Sum up all elements of a vector.
Definition dab_sum_elements_vff.h:62
dab_sum_elements_vff::work
int work(int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)
dab_sum_elements_vff::dab_make_sum_elements_vff
friend dab_sum_elements_vff_sptr dab_make_sum_elements_vff(unsigned int length)
Return a shared_ptr to a new instance of dab_sum_elements_vff.
dab_make_sum_elements_vff
dab_sum_elements_vff_sptr dab_make_sum_elements_vff(unsigned int length)
Return a shared_ptr to a new instance of dab_sum_elements_vff.