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

#include <spectrum-value.h>

Inheritance diagram for ns3::SpectrumValue:

Public Member Functions
	SpectrumValue (Ptr< const SpectrumModel > sm)
	SpectrumValue constructor. More...

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

SpectrumValue &	operator*= (const SpectrumValue &rhs)

SpectrumValue &	operator*= (double rhs)

SpectrumValue &	operator+= (const SpectrumValue &rhs)

SpectrumValue &	operator+= (double rhs)

SpectrumValue &	operator-= (const SpectrumValue &rhs)

SpectrumValue &	operator-= (double rhs)

SpectrumValue &	operator/= (const SpectrumValue &rhs)

SpectrumValue &	operator/= (double rhs)

SpectrumValue	operator<< (int n) const

SpectrumValue &	operator= (double rhs)

SpectrumValue	operator>> (int n) const

double &	operator[] (size_t index)

Values::iterator	ValuesBegin ()

Values::iterator	ValuesEnd ()

Public Member Functions inherited from ns3::SimpleRefCount< SpectrumValue >
	SimpleRefCount (const SimpleRefCount &o)

uint32_t	GetReferenceCount (void) const

SimpleRefCount &	operator= (const SimpleRefCount &o)

void	Ref (void) const

void	Unref (void) const

Private Member Functions
void	Add (const SpectrumValue &x)

void	Add (double s)

void	ChangeSign ()

void	Divide (const SpectrumValue &x)

void	Divide (double s)

void	Exp (double base)

void	Log ()

void	Log10 ()

void	Log2 ()

void	Multiply (const SpectrumValue &x)

void	Multiply (double s)

void	Pow (double exp)

void	ShiftLeft (int n)

void	ShiftRight (int n)

void	Subtract (const SpectrumValue &x)

void	Subtract (double s)

Private Attributes
Ptr< const SpectrumModel >	m_spectrumModel

Values	m_values

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)

SpectrumValue	operator* (const SpectrumValue &lhs, const SpectrumValue &rhs)

SpectrumValue	operator* (const SpectrumValue &lhs, double rhs)

SpectrumValue	operator* (double lhs, const SpectrumValue &rhs)

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

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

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

SpectrumValue	operator+ (const SpectrumValue &rhs)

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

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

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

SpectrumValue	operator- (const SpectrumValue &rhs)

SpectrumValue	operator/ (const SpectrumValue &lhs, const SpectrumValue &rhs)

SpectrumValue	operator/ (const SpectrumValue &lhs, double rhs)

SpectrumValue	operator/ (double lhs, const SpectrumValue &rhs)

SpectrumValue	Pow (const SpectrumValue &lhs, double rhs)

SpectrumValue	Pow (double lhs, const SpectrumValue &rhs)

double	Prod (const SpectrumValue &x)

double	Sum (const SpectrumValue &x)

Additional Inherited Members
Static Public Member Functions inherited from ns3::SimpleRefCount< SpectrumValue >
static void	Cleanup (void)

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 SetOfFreq. The codomain of the function space is implemented by SetOfValues

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 57 of file spectrum-value.h.

Constructor & Destructor Documentation

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 36 of file spectrum-value.cc.

Member Function Documentation

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

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

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

Referenced by ns3::Integral().

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

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

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

Referenced by ns3::Integral().

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

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

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

References m_values.

Referenced by ns3::LteAmc::CreateCqiFeedbacks(), ns3::LteUePhy::CreateDlCqiFeedbackMessage(), ns3::LteEnbPhy::CreatePuschCqiReport(), ns3::LteEnbPhy::CreateSrsCqiReport(), ns3::Integral(), ns3::Norm(), ns3::Prod(), and ns3::Sum().

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

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

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

References m_values.

Referenced by ns3::LteAmc::CreateCqiFeedbacks(), ns3::LteUePhy::CreateDlCqiFeedbackMessage(), ns3::LteEnbPhy::CreatePuschCqiReport(), ns3::LteEnbPhy::CreateSrsCqiReport(), ns3::Integral(), ns3::Norm(), ns3::Prod(), and ns3::Sum().

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

Returns: a Ptr to a copy of this instance

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

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

Returns: the embedded SpectrumModel

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

Referenced by ns3::SpectrumValueTestCase::DoRun().

SpectrumModelUid_t ns3::SpectrumValue::GetSpectrumModelUid ( ) const

Returns: the uid of the embedded SpectrumModel

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

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 611 of file spectrum-value.cc.

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 640 of file spectrum-value.cc.

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 597 of file spectrum-value.cc.

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 626 of file spectrum-value.cc.

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 604 of file spectrum-value.cc.

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 633 of file spectrum-value.cc.

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 618 of file spectrum-value.cc.

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 647 of file spectrum-value.cc.

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 670 of file spectrum-value.cc.

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

Assign each component of *this to the value of the Right Hand Side of the operator

Parameters

rhs

Returns

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

References m_values.

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

right shift operator

Parameters

n	position to shift

Returns: the value of *this right 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 678 of file spectrum-value.cc.

double & ns3::SpectrumValue::operator[] ( size_t index )

Access value at given frequency index

Parameters

index the given frequency index

Returns: reference to the value

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

References m_values.

Values::iterator ns3::SpectrumValue::ValuesBegin ( )

Returns: an iterator pointing to the beginning of the embedded SpectrumModel

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

References m_values.

Referenced by ns3::LteMiErrorModel::GetPcfichPdcchError().

Values::iterator ns3::SpectrumValue::ValuesEnd ( )

Returns: an iterator pointing to the end of the embedded SpectrumModel

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

References m_values.

Referenced by ns3::LteMiErrorModel::GetPcfichPdcchError().

Friends And Related Function Documentation

double Integral ( const SpectrumValue & arg )

friend

Parameters

arg	the argument

Returns: the value of the integral $\int_F g(f) df$

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

SpectrumValue Log ( const SpectrumValue & arg )

friend

Parameters

arg	the argument

Returns: the logarithm in base e of all values in the argument

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

Referenced by ns3::Log().

SpectrumValue Log10 ( const SpectrumValue & arg )

friend

Parameters

arg	the argument

Returns: the logarithm in base 10 of all values in the argument

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

Referenced by ns3::Log10().

SpectrumValue Log2 ( const SpectrumValue & arg )

friend

Parameters

arg	the argument

Returns: the logarithm in base 2 of all values in the argument

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

Referenced by ns3::Log2().

double Norm ( const SpectrumValue & x )

friend

Parameters

x	the operand

Returns: the euclidean norm, i.e., the sum of the squares of all the values in x

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

SpectrumValue operator*	(	const SpectrumValue &	lhs,
		const SpectrumValue &	rhs
	)

friend

multiplication component-by-component (Schur product)

Parameters

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

Returns: the value of lhs * rhs

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

SpectrumValue operator*	(	const SpectrumValue &	lhs,
		double	rhs
	)

friend

multiplication by a scalar

Parameters

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

Returns: the value of lhs * rhs

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

SpectrumValue operator*	(	double	lhs,
		const SpectrumValue &	rhs
	)

friend

multiplication of a scalar

Parameters

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

Returns: the value of lhs * rhs

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

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

friend

addition operator

Parameters

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

Returns: the value of lhs + rhs

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

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

friend

addition operator

Parameters

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

Returns: the value of lhs + rhs

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

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

friend

addition operator

Parameters

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

Returns: the value of lhs + rhs

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

SpectrumValue operator+ ( const SpectrumValue & rhs )

friend

unary plus operator

Returns: the value of *this

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

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

friend

subtraction operator

Parameters

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

Returns: the value of lhs - rhs

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

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

friend

subtraction operator

Parameters

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

Returns: the value of lhs - rhs

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

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

friend

subtraction operator

Parameters

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

Returns: the value of lhs - rhs

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

SpectrumValue operator- ( const SpectrumValue & rhs )

friend

unary minus operator

Returns: the value of - *this

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

SpectrumValue operator/	(	const SpectrumValue &	lhs,
		const SpectrumValue &	rhs
	)

friend

division component-by-component

Parameters

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

Returns: the value of lhs / rhs

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

SpectrumValue operator/	(	const SpectrumValue &	lhs,
		double	rhs
	)

friend

division by a scalar

Parameters

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

Returns: the value of *this / rhs

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

SpectrumValue operator/	(	double	lhs,
		const SpectrumValue &	rhs
	)

friend

division of a scalar

Parameters

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

Returns: the value of *this / rhs

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

SpectrumValue Pow	(	const SpectrumValue &	lhs,
		double	rhs
	)

friend

Parameters

lhs	the base
rhs	the exponent

Returns: each value in base raised to the exponent

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

Referenced by ns3::Pow().

SpectrumValue Pow	(	double	lhs,
		const SpectrumValue &	rhs
	)

friend

Parameters

lhs	the base
rhs	the exponent

Returns: the value in base raised to each value in the exponent

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

double Prod ( const SpectrumValue & x )

friend

Parameters

x	the operand

Returns: the product of all the values in x

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

double Sum ( const SpectrumValue & x )

friend

Parameters

x	the operand

Returns: the sum of all the values in x

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

Member Data Documentation

Values ns3::SpectrumValue::m_values

private

Set of values which implement the codomain of the functions in the Function Space defined by SpectrumValue. There is no restriction on what these values represent (a transmission power density, a propagation loss, etc.).

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

Referenced by ConstValuesBegin(), ConstValuesEnd(), operator=(), operator[](), ValuesBegin(), and ValuesEnd().

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

src/spectrum/model/spectrum-value.h
src/spectrum/model/spectrum-value.cc

Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation