Set of values corresponding to a given SpectrumModel. More...

#include "spectrum-value.h"

Inheritance diagram for ns3::SpectrumValue:

Collaboration diagram for ns3::SpectrumValue:

Public Types
typedef void(*	TracedCallback) (Ptr< SpectrumValue > value)
	TracedCallback signature for SpectrumValue.

Public Member Functions
	SpectrumValue ()

	SpectrumValue (Ptr< const SpectrumModel > sm)
	SpectrumValue constructor.

Bands::const_iterator	ConstBandsBegin () const

Bands::const_iterator	ConstBandsEnd () const

Values::const_iterator	ConstValuesBegin () const

Values::const_iterator	ConstValuesEnd () const

Ptr< SpectrumValue >	Copy () const

Ptr< const SpectrumModel >	GetSpectrumModel () const

SpectrumModelUid_t	GetSpectrumModelUid () const

Values &	GetValues ()
	Provides the direct access to the underlying std::vector<double> that stores the spectrum values.

const Values &	GetValues () const
	Provides the direct read-only access to the underlying std::vector<double> that stores the spectrum values.

uint32_t	GetValuesN () const
	Get the number of values stored in the array.

SpectrumValue &	operator*= (const SpectrumValue &rhs)
	Multiply *this by the Right Hand Side of the operator, component by component.

SpectrumValue &	operator*= (double rhs)
	Multiply every component of *this by the value of the Right Hand Side of the operator.

SpectrumValue &	operator+= (const SpectrumValue &rhs)
	Add the Right Hand Side of the operator to *this, component by component.

SpectrumValue &	operator+= (double rhs)
	Add the value of the Right Hand Side of the operator to all components of *this.

SpectrumValue &	operator-= (const SpectrumValue &rhs)
	Subtract the Right Hand Side of the operator from *this, component by component.

SpectrumValue &	operator-= (double rhs)
	Subtract the value of the Right Hand Side of the operator from all components of *this.

SpectrumValue &	operator/= (const SpectrumValue &rhs)
	Divide *this by the Right Hand Side of the operator, component by component.

SpectrumValue &	operator/= (double rhs)
	Divide every component of *this by the value of the Right Hand Side of the operator.

SpectrumValue	operator<< (int n) const
	left shift operator

SpectrumValue &	operator= (double rhs)
	Assign each component of *this to the value of the Right Hand Side of the operator.

SpectrumValue	operator>> (int n) const
	right shift operator

double &	operator[] (size_t index)
	Access value at given frequency index.

const double &	operator[] (size_t index) const
	Access value at given frequency index.

void	SetValues (Values &&values)
	Directly set the values by moving the values from the input std::vector<double>

void	SetValues (Values &values)
	Directly set the values using the std::vector<double>

const double &	ValuesAt (uint32_t pos) const
	Get the value element at the position.

Values::iterator	ValuesBegin ()

Values::iterator	ValuesEnd ()

Public Member Functions inherited from ns3::SimpleRefCount< SpectrumValue >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

uint32_t	GetReferenceCount () const
	Get the reference count of the object.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Private Member Functions
void	Add (const SpectrumValue &x)
	Add a SpectrumValue (element to element addition)

void	Add (double s)
	Add a flat value to all the current elements.

void	ChangeSign ()
	Change the values sign.

void	Divide (const SpectrumValue &x)
	Divides by a SpectrumValue (element to element division)

void	Divide (double s)
	Divides by a flat value to all the current elements.

void	Exp (double base)
	Modifies each element so that it is the base raised to each element value.

void	Log ()
	Applies a Log to each the elements.

void	Log10 ()
	Applies a Log10 to each the elements.

void	Log2 ()
	Applies a Log2 to each the elements.

void	Multiply (const SpectrumValue &x)
	Multiplies for a SpectrumValue (element to element multiplication)

void	Multiply (double s)
	Multiplies for a flat value to all the current elements.

void	Pow (double exp)
	Modifies each element so that it each element is raised to the exponent.

void	ShiftLeft (int n)
	Shift the values to the left.

void	ShiftRight (int n)
	Shift the values to the right.

void	Subtract (const SpectrumValue &x)
	Subtracts a SpectrumValue (element by element subtraction)

void	Subtract (double s)
	Subtracts a flat value to all the current elements.

Private Attributes
Ptr< const SpectrumModel >	m_spectrumModel
	The spectrum model.

Values	m_values
	Set of values which implement the codomain of the functions in the Function Space defined by SpectrumValue.

Friends
double	Integral (const SpectrumValue &arg)

SpectrumValue	Log (const SpectrumValue &arg)

SpectrumValue	Log10 (const SpectrumValue &arg)

SpectrumValue	Log2 (const SpectrumValue &arg)

double	Norm (const SpectrumValue &x)

bool	operator!= (const SpectrumValue &lhs, const SpectrumValue &rhs)
	Compare two spectrum values.

SpectrumValue	operator* (const SpectrumValue &lhs, const SpectrumValue &rhs)
	multiplication component-by-component (Schur product)

SpectrumValue	operator* (const SpectrumValue &lhs, double rhs)
	multiplication by a scalar

SpectrumValue	operator* (double lhs, const SpectrumValue &rhs)
	multiplication of a scalar

SpectrumValue	operator+ (const SpectrumValue &lhs, const SpectrumValue &rhs)
	addition operator

SpectrumValue	operator+ (const SpectrumValue &lhs, double rhs)
	addition operator

SpectrumValue	operator+ (const SpectrumValue &rhs)
	unary plus operator

SpectrumValue	operator+ (double lhs, const SpectrumValue &rhs)
	addition operator

SpectrumValue	operator- (const SpectrumValue &lhs, const SpectrumValue &rhs)
	subtraction operator

SpectrumValue	operator- (const SpectrumValue &lhs, double rhs)
	subtraction operator

SpectrumValue	operator- (const SpectrumValue &rhs)
	unary minus operator

SpectrumValue	operator- (double lhs, const SpectrumValue &rhs)
	subtraction operator

SpectrumValue	operator/ (const SpectrumValue &lhs, const SpectrumValue &rhs)
	division component-by-component

SpectrumValue	operator/ (const SpectrumValue &lhs, double rhs)
	division by a scalar

SpectrumValue	operator/ (double lhs, const SpectrumValue &rhs)
	division of a scalar

bool	operator== (const SpectrumValue &lhs, const SpectrumValue &rhs)
	Compare two spectrum values.

SpectrumValue	Pow (const SpectrumValue &lhs, double rhs)

SpectrumValue	Pow (double lhs, const SpectrumValue &rhs)

double	Prod (const SpectrumValue &x)

double	Sum (const SpectrumValue &x)

Detailed Description

Set of values corresponding to a given SpectrumModel.

This class implements a Function Space which can represent any function $g: F \in {\sf R\hspace*{-0.9ex}\rule{0.15ex}{1.5ex}\hspace*{0.9ex}}^N \rightarrow {\sf R\hspace*{-0.9ex}\rule{0.15ex}{1.5ex}\hspace*{0.9ex}}$

Every instance of this class represent a particular function $ g(F) $ . The domain of the function space, i.e., $ F $ , is implemented by Bands. The codomain of the function space is implemented by Values.

To every possible value of $ F$ corresponds a different Function Space. Mathematical operations are defined in this Function Space; these operations are implemented by means of operator overloading.

The intended use of this class is to represent frequency-dependent things, such as power spectral densities, frequency-dependent propagation losses, spectral masks, etc.

Definition at line 49 of file spectrum-value.h.

Member Typedef Documentation

◆ TracedCallback

typedef void(* ns3::SpectrumValue::TracedCallback) (Ptr< SpectrumValue > value)

TracedCallback signature for SpectrumValue.

Parameters

[in] value Value of the traced variable.

Deprecated: The non-const Ptr<SpectrumPhy> argument is deprecated and will be changed to Ptr<const SpectrumPhy> in a future release.

Definition at line 562 of file spectrum-value.h.

Constructor & Destructor Documentation

◆ SpectrumValue() [1/2]

ns3::SpectrumValue::SpectrumValue ( Ptr< const SpectrumModel > sm )

SpectrumValue constructor.

Parameters

sm	pointer to the SpectrumModel which implements the set of frequencies to which the values will be referring.

Warning: the intended use if that sm points to a static object which will be there for the whole simulation. This is reasonable since the set of frequencies which are to be used in the simulation is normally known before the simulation starts. Make sure that the SpectrumModel instance which sm points to has already been initialized by the time this method is invoked. The main reason is that if you initialize the SpectrumModel instance afterwards, and the memory for the underlying std::vector gets reallocated, then sm will not be a valid reference anymore. Another reason is that m_values could end up having the wrong size.

Definition at line 23 of file spectrum-value.cc.

References m_spectrumModel, and m_values.

Referenced by Add(), Divide(), Integral, Log, Log10, Log2, Multiply(), Norm, operator!=, operator*, operator*, operator*, operator*=(), operator+, operator+, operator+, operator+, operator+=(), operator-, operator-, operator-, operator-, operator-=(), operator/, operator/, operator/, operator/=(), operator<<(), operator==, operator>>(), Pow, Pow, Prod, Subtract(), and Sum.

Here is the caller graph for this function:

◆ SpectrumValue() [2/2]

ns3::SpectrumValue::SpectrumValue ( )

Definition at line 19 of file spectrum-value.cc.

Member Function Documentation

◆ Add() [1/2]

void ns3::SpectrumValue::Add ( const SpectrumValue & x )

private

Add a SpectrumValue (element to element addition)

Parameters

x	SpectrumValue

Definition at line 90 of file spectrum-value.cc.

References SpectrumValue(), m_spectrumModel, m_values, and NS_ASSERT.

Referenced by operator+=(), operator+=(), and Subtract().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Add() [2/2]

void ns3::SpectrumValue::Add ( double s )

private

Add a flat value to all the current elements.

Parameters

s	flat value

Definition at line 107 of file spectrum-value.cc.

References m_values.

◆ ChangeSign()

void ns3::SpectrumValue::ChangeSign ( )

private

Change the values sign.

Definition at line 201 of file spectrum-value.cc.

References m_values.

◆ ConstBandsBegin()

Bands::const_iterator ns3::SpectrumValue::ConstBandsBegin ( ) const

Returns: a const iterator pointing to the beginning of the embedded Bands

Definition at line 78 of file spectrum-value.cc.

References m_spectrumModel.

Referenced by ns3::ShannonSpectrumErrorModel::EvaluateChunk(), and Integral.

Here is the caller graph for this function:

◆ ConstBandsEnd()

Bands::const_iterator ns3::SpectrumValue::ConstBandsEnd ( ) const

Returns: a const iterator pointing to the end of the embedded Bands

Definition at line 84 of file spectrum-value.cc.

References m_spectrumModel.

Referenced by ns3::ShannonSpectrumErrorModel::EvaluateChunk(), and Integral.

Here is the caller graph for this function:

◆ ConstValuesBegin()

Values::const_iterator ns3::SpectrumValue::ConstValuesBegin ( ) const

Returns: a const iterator pointing to the beginning of the embedded Values

Definition at line 54 of file spectrum-value.cc.

References m_values.

Referenced by ns3::LteUePhy::ComputeAvgSinr(), ns3::LteAmc::CreateCqiFeedbacks(), ns3::LteEnbPhy::CreatePuschCqiReport(), ns3::LteEnbPhy::CreateSrsCqiReport(), ns3::ShannonSpectrumErrorModel::EvaluateChunk(), ns3::LteMiErrorModel::GetPcfichPdcchError(), Integral, and ns3::operator<<().

Here is the caller graph for this function:

◆ ConstValuesEnd()

Values::const_iterator ns3::SpectrumValue::ConstValuesEnd ( ) const

Returns: a const iterator pointing to the end of the embedded Values

Definition at line 60 of file spectrum-value.cc.

References m_values.

Referenced by ns3::LteUePhy::ComputeAvgSinr(), ns3::LteAmc::CreateCqiFeedbacks(), ns3::LteEnbPhy::CreatePuschCqiReport(), ns3::LteEnbPhy::CreateSrsCqiReport(), ns3::ShannonSpectrumErrorModel::EvaluateChunk(), ns3::LteMiErrorModel::GetPcfichPdcchError(), Integral, and ns3::operator<<().

Here is the caller graph for this function:

◆ Copy()

Ptr< SpectrumValue > ns3::SpectrumValue::Copy ( ) const

Returns: a Ptr to a copy of this instance

Definition at line 366 of file spectrum-value.cc.

References ns3::Create(), and m_spectrumModel.

Referenced by LteUplinkSrsSinrTestCase::ReportSinr().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Divide() [1/2]

void ns3::SpectrumValue::Divide ( const SpectrumValue & x )

private

Divides by a SpectrumValue (element to element division)

Parameters

x	SpectrumValue

Definition at line 171 of file spectrum-value.cc.

References SpectrumValue(), m_spectrumModel, m_values, and NS_ASSERT.

Referenced by operator/=(), and operator/=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Divide() [2/2]

void ns3::SpectrumValue::Divide ( double s )

private

Divides by a flat value to all the current elements.

Parameters

s	flat value

Definition at line 188 of file spectrum-value.cc.

References m_values, and NS_LOG_FUNCTION.

◆ Exp()

void ns3::SpectrumValue::Exp ( double base )

private

Modifies each element so that it is the base raised to each element value.

Parameters

base the base

Definition at line 258 of file spectrum-value.cc.

References m_values, and NS_LOG_FUNCTION.

◆ GetSpectrumModel()

Ptr< const SpectrumModel > ns3::SpectrumValue::GetSpectrumModel ( ) const

Returns: the embedded SpectrumModel

Definition at line 48 of file spectrum-value.cc.

References m_spectrumModel.

Referenced by ns3::LteChunkProcessor::EvaluateChunk().

Here is the caller graph for this function:

◆ GetSpectrumModelUid()

SpectrumModelUid_t ns3::SpectrumValue::GetSpectrumModelUid ( ) const

Returns: the uid of the embedded SpectrumModel

Definition at line 42 of file spectrum-value.cc.

References m_spectrumModel.

◆ GetValues() [1/2]

Values & ns3::SpectrumValue::GetValues ( )

inline

Provides the direct access to the underlying std::vector<double> that stores the spectrum values.

Returns: a reference to the stored values

Definition at line 180 of file spectrum-value.h.

References m_values.

◆ GetValues() [2/2]

const Values & ns3::SpectrumValue::GetValues ( ) const

inline

Provides the direct read-only access to the underlying std::vector<double> that stores the spectrum values.

Returns: a const reference to the stored values

Definition at line 190 of file spectrum-value.h.

References m_values.

◆ GetValuesN()

uint32_t ns3::SpectrumValue::GetValuesN ( ) const

Get the number of values stored in the array.

Returns: the values array size

Definition at line 651 of file spectrum-value.cc.

References m_values.

◆ Log()

void ns3::SpectrumValue::Log ( )

private

Applies a Log to each the elements.

Definition at line 297 of file spectrum-value.cc.

References m_values, and NS_LOG_FUNCTION.

◆ Log10()

void ns3::SpectrumValue::Log10 ( )

private

Applies a Log10 to each the elements.

Definition at line 271 of file spectrum-value.cc.

References m_values, and NS_LOG_FUNCTION.

◆ Log2()

void ns3::SpectrumValue::Log2 ( )

private

Applies a Log2 to each the elements.

Definition at line 284 of file spectrum-value.cc.

References m_values, and NS_LOG_FUNCTION.

◆ Multiply() [1/2]

void ns3::SpectrumValue::Multiply ( const SpectrumValue & x )

private

Multiplies for a SpectrumValue (element to element multiplication)

Parameters

x	SpectrumValue

Definition at line 142 of file spectrum-value.cc.

References SpectrumValue(), m_spectrumModel, m_values, and NS_ASSERT.

Referenced by operator*=(), and operator*=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Multiply() [2/2]

void ns3::SpectrumValue::Multiply ( double s )

private

Multiplies for a flat value to all the current elements.

Parameters

s	flat value

Definition at line 159 of file spectrum-value.cc.

References m_values.

◆ operator*=() [1/2]

SpectrumValue & ns3::SpectrumValue::operator*= ( const SpectrumValue & rhs )

Multiply *this by the Right Hand Side of the operator, component by component.

Parameters

rhs	the Right Hand Side

Returns: a reference to *this

Definition at line 580 of file spectrum-value.cc.

References SpectrumValue(), and Multiply().

Here is the call graph for this function:

◆ operator*=() [2/2]

SpectrumValue & ns3::SpectrumValue::operator*= ( double rhs )

Multiply every component of *this by the value of the Right Hand Side of the operator.

Parameters

rhs	the Right Hand Side

Returns: a reference to *this

Definition at line 608 of file spectrum-value.cc.

References Multiply().

Here is the call graph for this function:

◆ operator+=() [1/2]

SpectrumValue & ns3::SpectrumValue::operator+= ( const SpectrumValue & rhs )

Add the Right Hand Side of the operator to *this, component by component.

Parameters

rhs	the Right Hand Side

Returns: a reference to *this

Definition at line 566 of file spectrum-value.cc.

References SpectrumValue(), and Add().

Here is the call graph for this function:

◆ operator+=() [2/2]

SpectrumValue & ns3::SpectrumValue::operator+= ( double rhs )

Add the value of the Right Hand Side of the operator to all components of *this.

Parameters

rhs	the Right Hand Side

Returns: a reference to *this

Definition at line 594 of file spectrum-value.cc.

References Add().

Here is the call graph for this function:

◆ operator-=() [1/2]

SpectrumValue & ns3::SpectrumValue::operator-= ( const SpectrumValue & rhs )

Subtract the Right Hand Side of the operator from *this, component by component.

Parameters

rhs	the Right Hand Side

Returns: a reference to *this

Definition at line 573 of file spectrum-value.cc.

References SpectrumValue(), and Subtract().

Here is the call graph for this function:

◆ operator-=() [2/2]

SpectrumValue & ns3::SpectrumValue::operator-= ( double rhs )

Subtract the value of the Right Hand Side of the operator from all components of *this.

Parameters

rhs	the Right Hand Side

Returns: a reference to *this

Definition at line 601 of file spectrum-value.cc.

References Subtract().

Here is the call graph for this function:

◆ operator/=() [1/2]

SpectrumValue & ns3::SpectrumValue::operator/= ( const SpectrumValue & rhs )

Divide *this by the Right Hand Side of the operator, component by component.

Parameters

rhs	the Right Hand Side

Returns: a reference to *this

Definition at line 587 of file spectrum-value.cc.

References SpectrumValue(), and Divide().

Here is the call graph for this function:

◆ operator/=() [2/2]

SpectrumValue & ns3::SpectrumValue::operator/= ( double rhs )

Divide every component of *this by the value of the Right Hand Side of the operator.

Parameters

rhs	the Right Hand Side

Returns: a reference to *this

Definition at line 615 of file spectrum-value.cc.

References Divide().

Here is the call graph for this function:

◆ operator<<()

SpectrumValue ns3::SpectrumValue::operator<< ( int n ) const

left shift operator

Parameters

n	position to shift

Returns: the value of *this left shifted by n positions. In other words, the function of the set of frequencies represented by *this is left-shifted in frequency by n positions.

Definition at line 634 of file spectrum-value.cc.

lhs	Left Hand Side of the operator
rhs	Right Hand Side of the operator

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ TracedCallback

Constructor & Destructor Documentation

◆ SpectrumValue() [1/2]

◆ SpectrumValue() [2/2]

Member Function Documentation

◆ Add() [1/2]

◆ Add() [2/2]

◆ ChangeSign()

◆ ConstBandsBegin()

◆ ConstBandsEnd()

◆ ConstValuesBegin()

◆ ConstValuesEnd()

◆ Copy()

◆ Divide() [1/2]

◆ Divide() [2/2]

◆ Exp()

◆ GetSpectrumModel()

◆ GetSpectrumModelUid()

◆ GetValues() [1/2]

◆ GetValues() [2/2]

◆ GetValuesN()

◆ Log()

◆ Log10()

◆ Log2()

◆ Multiply() [1/2]

◆ Multiply() [2/2]

◆ operator*=() [1/2]

◆ operator*=() [2/2]

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator-=() [1/2]

◆ operator-=() [2/2]

◆ operator/=() [1/2]

◆ operator/=() [2/2]

◆ operator<<()

◆ operator=()

◆ operator>>()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ Pow()

◆ SetValues() [1/2]

◆ SetValues() [2/2]

◆ ShiftLeft()

◆ ShiftRight()

◆ Subtract() [1/2]

◆ Subtract() [2/2]

◆ ValuesAt()

◆ ValuesBegin()

◆ ValuesEnd()

Friends And Related Symbol Documentation

◆ Integral

◆ Log

◆ Log10

◆ Log2

◆ Norm

◆ operator!=

◆ operator* [1/3]

◆ operator* [2/3]

◆ operator* [3/3]

◆ operator+ [1/4]

◆ operator+ [2/4]

◆ operator+ [3/4]

◆ operator+ [4/4]

◆ operator- [1/4]

◆ operator- [2/4]

◆ operator- [3/4]

◆ operator- [4/4]

◆ operator/ [1/3]

◆ operator/ [2/3]

◆ operator/ [3/3]

◆ operator==

◆ Pow [1/2]

◆ Pow [2/2]