A Discrete-Event Network Simulator
API
ns3::SpectrumValue Class Reference

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. More...
 

Public Member Functions

 SpectrumValue ()
 
 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< SpectrumValueCopy () const
 
Ptr< const SpectrumModelGetSpectrumModel () const
 
SpectrumModelUid_t GetSpectrumModelUid () const
 
uint32_t GetValuesN () const
 Get the number of values stored in the array. More...
 
SpectrumValueoperator*= (const SpectrumValue &rhs)
 Multiply *this by the Right Hand Side of the operator, component by component. More...
 
SpectrumValueoperator*= (double rhs)
 Multiply every component of *this by the value of the Right Hand Side of the operator. More...
 
SpectrumValueoperator+= (const SpectrumValue &rhs)
 Add the Right Hand Side of the operator to *this, component by component. More...
 
SpectrumValueoperator+= (double rhs)
 Add the value of the Right Hand Side of the operator to all components of *this. More...
 
SpectrumValueoperator-= (const SpectrumValue &rhs)
 Subtract the Right Hand Side of the operator from *this, component by component. More...
 
SpectrumValueoperator-= (double rhs)
 Subtract the value of the Right Hand Side of the operator from all components of *this. More...
 
SpectrumValueoperator/= (const SpectrumValue &rhs)
 Divide *this by the Right Hand Side of the operator, component by component. More...
 
SpectrumValueoperator/= (double rhs)
 Divide every component of *this by the value of the Right Hand Side of the operator. More...
 
SpectrumValue operator<< (int n) const
 left shift operator More...
 
SpectrumValueoperator= (double rhs)
 Assign each component of *this to the value of the Right Hand Side of the operator. More...
 
SpectrumValue operator>> (int n) const
 right shift operator More...
 
doubleoperator[] (size_t index)
 Access value at given frequency index. More...
 
const doubleoperator[] (size_t index) const
 Access value at given frequency index. More...
 
const doubleValuesAt (uint32_t pos) const
 Get the value element at the position. More...
 
Values::iterator ValuesBegin ()
 
Values::iterator ValuesEnd ()
 
- Public Member Functions inherited from ns3::SimpleRefCount< SpectrumValue >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 

Private Member Functions

void Add (const SpectrumValue &x)
 Add a SpectrumValue (element to element addition) More...
 
void Add (double s)
 Add a flat value to all the current elements. More...
 
void ChangeSign ()
 Change the values sign. More...
 
void Divide (const SpectrumValue &x)
 Divides by a SpectrumValue (element to element division) More...
 
void Divide (double s)
 Divides by a flat value to all the current elements. More...
 
void Exp (double base)
 Modifies each element so that it is the base raised to each element value. More...
 
void Log ()
 Applies a Log to each the elements. More...
 
void Log10 ()
 Applies a Log10 to each the elements. More...
 
void Log2 ()
 Applies a Log2 to each the elements. More...
 
void Multiply (const SpectrumValue &x)
 Multiplies for a SpectrumValue (element to element multiplication) More...
 
void Multiply (double s)
 Multiplies for a flat value to all the current elements. More...
 
void Pow (double exp)
 Modifies each element so that it each element is raised to the exponent. More...
 
void ShiftLeft (int n)
 Shift the values to the left. More...
 
void ShiftRight (int n)
 Shift the values to the right. More...
 
void Subtract (const SpectrumValue &x)
 Subtracts a SpectrumValue (element by element subtraction) More...
 
void Subtract (double s)
 Subtracts a flat value to all the current elements. More...
 

Private Attributes

Ptr< const SpectrumModelm_spectrumModel
 The spectrum model. More...
 
Values m_values
 Set of values which implement the codomain of the functions in the Function Space defined by SpectrumValue. More...
 

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)
 multiplication component-by-component (Schur product) More...
 
SpectrumValue operator* (const SpectrumValue &lhs, double rhs)
 multiplication by a scalar More...
 
SpectrumValue operator* (double lhs, const SpectrumValue &rhs)
 multiplication of a scalar More...
 
SpectrumValue operator+ (const SpectrumValue &lhs, const SpectrumValue &rhs)
 addition operator More...
 
SpectrumValue operator+ (const SpectrumValue &lhs, double rhs)
 addition operator More...
 
SpectrumValue operator+ (const SpectrumValue &rhs)
 unary plus operator More...
 
SpectrumValue operator+ (double lhs, const SpectrumValue &rhs)
 addition operator More...
 
SpectrumValue operator- (const SpectrumValue &lhs, const SpectrumValue &rhs)
 subtraction operator More...
 
SpectrumValue operator- (const SpectrumValue &lhs, double rhs)
 subtraction operator More...
 
SpectrumValue operator- (const SpectrumValue &rhs)
 unary minus operator More...
 
SpectrumValue operator- (double lhs, const SpectrumValue &rhs)
 subtraction operator More...
 
SpectrumValue operator/ (const SpectrumValue &lhs, const SpectrumValue &rhs)
 division component-by-component More...
 
SpectrumValue operator/ (const SpectrumValue &lhs, double rhs)
 division by a scalar More...
 
SpectrumValue operator/ (double lhs, const SpectrumValue &rhs)
 division of a scalar More...
 
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 58 of file spectrum-value.h.

Member Typedef Documentation

◆ TracedCallback

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

TracedCallback signature for SpectrumValue.

Parameters
[in]valueValue 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 525 of file spectrum-value.h.

Constructor & Destructor Documentation

◆ SpectrumValue() [1/2]

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

SpectrumValue constructor.

Parameters
smpointer 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 34 of file spectrum-value.cc.

◆ SpectrumValue() [2/2]

ns3::SpectrumValue::SpectrumValue ( )

Definition at line 30 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
xSpectrumValue

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

References m_spectrumModel, m_values, and NS_ASSERT.

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

+ 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
sflat value

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

References m_values.

◆ ChangeSign()

void ns3::SpectrumValue::ChangeSign ( )
private

Change the values sign.

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

References m_values.

◆ ConstBandsBegin()

◆ ConstBandsEnd()

Bands::const_iterator ns3::SpectrumValue::ConstBandsEnd ( ) const
Returns
a const iterator pointing to the end of the embedded Bands

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

References ns3::SpectrumModel::End(), and m_spectrumModel.

Referenced by ns3::ConstantSpectrumPropagationLossModel::DoCalcRxPowerSpectralDensity(), ns3::FriisSpectrumPropagationLossModel::DoCalcRxPowerSpectralDensity(), TvSpectrumTransmitterTestCase::DoRun(), and ns3::ShannonSpectrumErrorModel::EvaluateChunk().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ ConstValuesBegin()

◆ ConstValuesEnd()

◆ Copy()

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

◆ Divide() [1/2]

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

Divides by a SpectrumValue (element to element division)

Parameters
xSpectrumValue

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

References m_spectrumModel, m_values, and NS_ASSERT.

Referenced by operator/=().

+ 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
sflat value

Definition at line 216 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
basethe base

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

References m_values, and NS_LOG_FUNCTION.

◆ GetSpectrumModel()

◆ GetSpectrumModelUid()

SpectrumModelUid_t ns3::SpectrumValue::GetSpectrumModelUid ( ) const
Returns
the uid of the embedded SpectrumModel

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

References ns3::SpectrumModel::GetUid(), and m_spectrumModel.

Referenced by LteDownlinkPowerControlSpectrumValueTestCase::DoRun(), LteNoisePsdTestCase::DoRun(), LteTxPsdTestCase::DoRun(), and ns3::MultiModelSpectrumChannel::StartTx().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetValuesN()

uint32_t ns3::SpectrumValue::GetValuesN ( ) const

Get the number of values stored in the array.

Returns
the values array size

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

References m_values.

◆ Log()

void ns3::SpectrumValue::Log ( )
private

Applies a Log to each the elements.

Definition at line 335 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 308 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 321 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
xSpectrumValue

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

References m_spectrumModel, m_values, and NS_ASSERT.

Referenced by operator*=().

+ 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
sflat value

Definition at line 183 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
rhsthe Right Hand Side
Returns
a reference to *this

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

References 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
rhsthe Right Hand Side
Returns
a reference to *this

Definition at line 650 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
rhsthe Right Hand Side
Returns
a reference to *this

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

References 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
rhsthe Right Hand Side
Returns
a reference to *this

Definition at line 636 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
rhsthe Right Hand Side
Returns
a reference to *this

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

References 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
rhsthe Right Hand Side
Returns
a reference to *this

Definition at line 643 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
rhsthe Right Hand Side
Returns
a reference to *this

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

References 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
rhsthe Right Hand Side
Returns
a reference to *this

Definition at line 657 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
nposition 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 679 of file spectrum-value.cc.

References ShiftLeft().

+ Here is the call graph for this function:

◆ operator=()

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

References m_values.

◆ operator>>()

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

right shift operator

Parameters
nposition 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 688 of file spectrum-value.cc.

References ShiftRight().

+ Here is the call graph for this function:

◆ operator[]() [1/2]

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

Access value at given frequency index.

Parameters
indexthe given frequency index
Returns
reference to the value

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

References m_values.

◆ operator[]() [2/2]

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

Access value at given frequency index.

Parameters
indexthe given frequency index
Returns
const reference to the value

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

References m_values.

◆ Pow()

void ns3::SpectrumValue::Pow ( double  exp)
private

Modifies each element so that it each element is raised to the exponent.

Parameters
expthe exponent

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

References m_values, and NS_LOG_FUNCTION.

◆ ShiftLeft()

void ns3::SpectrumValue::ShiftLeft ( int  n)
private

Shift the values to the left.

Parameters
nnumber of positions to shift

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

References m_values.

Referenced by operator<<().

+ Here is the caller graph for this function:

◆ ShiftRight()

void ns3::SpectrumValue::ShiftRight ( int  n)
private

Shift the values to the right.

Parameters
nnumber of positions to shift

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

References m_values.

Referenced by operator>>().

+ Here is the caller graph for this function:

◆ Subtract() [1/2]

void ns3::SpectrumValue::Subtract ( const SpectrumValue x)
private

Subtracts a SpectrumValue (element by element subtraction)

Parameters
xSpectrumValue

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

References m_spectrumModel, m_values, and NS_ASSERT.

Referenced by operator-=().

+ Here is the caller graph for this function:

◆ Subtract() [2/2]

void ns3::SpectrumValue::Subtract ( double  s)
private

Subtracts a flat value to all the current elements.

Parameters
sflat value

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

References Add().

+ Here is the call graph for this function:

◆ ValuesAt()

const double & ns3::SpectrumValue::ValuesAt ( uint32_t  pos) const

Get the value element at the position.

Parameters
posposition
Returns
the value element in that position (with bounds checking)

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

References m_values.

◆ ValuesBegin()

◆ ValuesEnd()

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

Friends And Related Function Documentation

◆ Integral

double Integral ( const SpectrumValue arg)
friend
Parameters
argthe argument
Returns
the value of the integral $\int_F g(f) df $

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

◆ Log

SpectrumValue Log ( const SpectrumValue arg)
friend
Parameters
argthe argument
Returns
the logarithm in base e of all values in the argument

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

◆ Log10

SpectrumValue Log10 ( const SpectrumValue arg)
friend
Parameters
argthe argument
Returns
the logarithm in base 10 of all values in the argument

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

◆ Log2

SpectrumValue Log2 ( const SpectrumValue arg)
friend
Parameters
argthe argument
Returns
the logarithm in base 2 of all values in the argument

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

◆ Norm

double Norm ( const SpectrumValue x)
friend
Parameters
xthe operand
Returns
the euclidean norm, i.e., the sum of the squares of all the values in x

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

◆ operator* [1/3]

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

multiplication component-by-component (Schur product)

Parameters
lhsLeft Hand Side of the operator
rhsRight Hand Side of the operator
Returns
the value of lhs * rhs

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

◆ operator* [2/3]

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

multiplication by a scalar

Parameters
lhsLeft Hand Side of the operator
rhsRight Hand Side of the operator
Returns
the value of lhs * rhs

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

◆ operator* [3/3]

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

multiplication of a scalar

Parameters
lhsLeft Hand Side of the operator
rhsRight Hand Side of the operator
Returns
the value of lhs * rhs

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

◆ operator+ [1/4]

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

addition operator

Parameters
lhsLeft Hand Side of the operator
rhsRight Hand Side of the operator
Returns
the value of lhs + rhs

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

◆ operator+ [2/4]

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

addition operator

Parameters
lhsLeft Hand Side of the operator
rhsRight Hand Side of the operator
Returns
the value of lhs + rhs

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

◆ operator+ [3/4]

SpectrumValue operator+ ( const SpectrumValue rhs)
friend

unary plus operator

Parameters
rhsRight Hand Side of the operator
Returns
the value of *this

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

◆ operator+ [4/4]

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

addition operator

Parameters
lhsLeft Hand Side of the operator
rhsRight Hand Side of the operator
Returns
the value of lhs + rhs

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

◆ operator- [1/4]

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

subtraction operator

Parameters
lhsLeft Hand Side of the operator
rhsRight Hand Side of the operator
Returns
the value of lhs - rhs

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

◆ operator- [2/4]

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

subtraction operator

Parameters
lhsLeft Hand Side of the operator
rhsRight Hand Side of the operator
Returns
the value of lhs - rhs

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

◆ operator- [3/4]

SpectrumValue operator- ( const SpectrumValue rhs)
friend

unary minus operator

Parameters
rhsRight Hand Side of the operator
Returns
the value of - *this

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

◆ operator- [4/4]

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

subtraction operator

Parameters
lhsLeft Hand Side of the operator
rhsRight Hand Side of the operator
Returns
the value of lhs - rhs

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

◆ operator/ [1/3]

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

division component-by-component

Parameters
lhsLeft Hand Side of the operator
rhsRight Hand Side of the operator
Returns
the value of lhs / rhs

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

◆ operator/ [2/3]

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

division by a scalar

Parameters
lhsLeft Hand Side of the operator
rhsRight Hand Side of the operator
Returns
the value of *this / rhs

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

◆ operator/ [3/3]

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

division of a scalar

Parameters
lhsLeft Hand Side of the operator
rhsRight Hand Side of the operator
Returns
the value of *this / rhs

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

◆ Pow [1/2]

SpectrumValue Pow ( const SpectrumValue lhs,
double  rhs 
)
friend
Parameters
lhsthe base
rhsthe exponent
Returns
each value in base raised to the exponent

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

◆ Pow [2/2]

SpectrumValue Pow ( double  lhs,
const SpectrumValue rhs 
)
friend
Parameters
lhsthe base
rhsthe exponent
Returns
the value in base raised to each value in the exponent

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

◆ Prod

double Prod ( const SpectrumValue x)
friend
Parameters
xthe operand
Returns
the product of all the values in x

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

◆ Sum

double Sum ( const SpectrumValue x)
friend
Parameters
xthe operand
Returns
the sum of all the values in x

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

Member Data Documentation

◆ m_spectrumModel

Ptr<const SpectrumModel> ns3::SpectrumValue::m_spectrumModel
private

The spectrum model.

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

Referenced by Add(), ConstBandsBegin(), ConstBandsEnd(), Copy(), Divide(), GetSpectrumModel(), GetSpectrumModelUid(), Multiply(), and Subtract().

◆ m_values

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

Referenced by Add(), ChangeSign(), ConstValuesBegin(), ConstValuesEnd(), Divide(), Exp(), GetValuesN(), Log(), Log10(), Log2(), Multiply(), operator=(), operator[](), Pow(), ShiftLeft(), ShiftRight(), Subtract(), ValuesAt(), ValuesBegin(), and ValuesEnd().


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