spectrum-value.h

Go to the documentation of this file.

/*
 * Copyright (c) 2009 CTTC
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Nicola Baldo <nbaldo@cttc.es>
 */
 
#ifndef SPECTRUM_VALUE_H
#define SPECTRUM_VALUE_H
 
#include "spectrum-model.h"
 
#include <ns3/ptr.h>
#include <ns3/simple-ref-count.h>
 
#include <ostream>
#include <vector>
 
namespace ns3
{
 
typedef std::vector<double> Values;
 
class SpectrumValue : public SimpleRefCount<SpectrumValue>
{
  public:
    SpectrumValue(Ptr<const SpectrumModel> sm);
 
    SpectrumValue();
 
    double& operator[](size_t index);
 
    const double& operator[](size_t index) const;
 
    SpectrumModelUid_t GetSpectrumModelUid() const;
 
    Ptr<const SpectrumModel> GetSpectrumModel() const;
 
    Bands::const_iterator ConstBandsBegin() const;
 
    Bands::const_iterator ConstBandsEnd() const;
 
    Values::const_iterator ConstValuesBegin() const;
 
    Values::const_iterator ConstValuesEnd() const;
 
    Values::iterator ValuesBegin();
 
    Values::iterator ValuesEnd();
 
    uint32_t GetValuesN() const;
 
    inline void SetValues(Values& values)
    {
        NS_ASSERT_MSG(
            values.size() == m_spectrumModel->GetNumBands(),
            "Values size does not correspond to the SpectrumModel in use by this SpectrumValue.");
        m_values = values;
    }
 
    inline void SetValues(Values&& values)
    {
        NS_ASSERT_MSG(
            values.size() == m_spectrumModel->GetNumBands(),
            "Values size does not correspond to the SpectrumModel in use by this SpectrumValue.");
        m_values = std::move(values);
    }
 
    inline Values& GetValues()
    {
        return m_values;
    }
 
    inline const Values& GetValues() const
    {
        return m_values;
    }
 
    const double& ValuesAt(uint32_t pos) const;
 
    friend SpectrumValue operator+(const SpectrumValue& lhs, const SpectrumValue& rhs);
 
    friend SpectrumValue operator+(const SpectrumValue& lhs, double rhs);
 
    friend SpectrumValue operator+(double lhs, const SpectrumValue& rhs);
 
    friend SpectrumValue operator-(const SpectrumValue& lhs, const SpectrumValue& rhs);
 
    friend SpectrumValue operator-(const SpectrumValue& lhs, double rhs);
 
    friend SpectrumValue operator-(double lhs, const SpectrumValue& rhs);
 
    friend SpectrumValue operator*(const SpectrumValue& lhs, const SpectrumValue& rhs);
 
    friend SpectrumValue operator*(const SpectrumValue& lhs, double rhs);
 
    friend SpectrumValue operator*(double lhs, const SpectrumValue& rhs);
 
    friend SpectrumValue operator/(const SpectrumValue& lhs, const SpectrumValue& rhs);
 
    friend SpectrumValue operator/(const SpectrumValue& lhs, double rhs);
 
    friend SpectrumValue operator/(double lhs, const SpectrumValue& rhs);
 
    friend bool operator==(const SpectrumValue& lhs, const SpectrumValue& rhs);
 
    friend bool operator!=(const SpectrumValue& lhs, const SpectrumValue& rhs);
 
    friend SpectrumValue operator+(const SpectrumValue& rhs);
 
    friend SpectrumValue operator-(const SpectrumValue& rhs);
 
    SpectrumValue operator<<(int n) const;
 
    SpectrumValue operator>>(int n) const;
 
    SpectrumValue& operator+=(const SpectrumValue& rhs);
 
    SpectrumValue& operator-=(const SpectrumValue& rhs);
 
    SpectrumValue& operator*=(const SpectrumValue& rhs);
 
    SpectrumValue& operator/=(const SpectrumValue& rhs);
 
    SpectrumValue& operator+=(double rhs);
 
    SpectrumValue& operator-=(double rhs);
 
    SpectrumValue& operator*=(double rhs);
 
    SpectrumValue& operator/=(double rhs);
 
    SpectrumValue& operator=(double rhs);
 
    friend double Norm(const SpectrumValue& x);
 
    friend double Sum(const SpectrumValue& x);
 
    friend double Prod(const SpectrumValue& x);
 
    friend SpectrumValue Pow(const SpectrumValue& lhs, double rhs);
 
    friend SpectrumValue Pow(double lhs, const SpectrumValue& rhs);
 
    friend SpectrumValue Log10(const SpectrumValue& arg);
 
    friend SpectrumValue Log2(const SpectrumValue& arg);
 
    friend SpectrumValue Log(const SpectrumValue& arg);
 
    friend double Integral(const SpectrumValue& arg);
 
    Ptr<SpectrumValue> Copy() const;
 
    typedef void (*TracedCallback)(Ptr<SpectrumValue> value);
 
  private:
    void Add(const SpectrumValue& x);
    void Add(double s);
    void Subtract(const SpectrumValue& x);
    void Subtract(double s);
    void Multiply(const SpectrumValue& x);
    void Multiply(double s);
    void Divide(const SpectrumValue& x);
    void Divide(double s);
    void ChangeSign();
    void ShiftLeft(int n);
    void ShiftRight(int n);
    void Pow(double exp);
    void Exp(double base);
    void Log10();
    void Log2();
    void Log();
 
    Ptr<const SpectrumModel> m_spectrumModel; 
 
    Values m_values;
};
 
std::ostream& operator<<(std::ostream& os, const SpectrumValue& pvf);
 
double Norm(const SpectrumValue& x);
double Sum(const SpectrumValue& x);
double Prod(const SpectrumValue& x);
SpectrumValue Pow(const SpectrumValue& lhs, double rhs);
SpectrumValue Pow(double lhs, const SpectrumValue& rhs);
SpectrumValue Log10(const SpectrumValue& arg);
SpectrumValue Log2(const SpectrumValue& arg);
SpectrumValue Log(const SpectrumValue& arg);
double Integral(const SpectrumValue& arg);
 
} // namespace ns3
 
#endif /* SPECTRUM_VALUE_H */