A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
ns3::SpectrumValue Class Reference
Spectrum Models

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

#include <spectrum-value.h>

+ Inheritance diagram for ns3::SpectrumValue:
+ Collaboration diagram for ns3::SpectrumValue:

Public Member Functions

 SpectrumValue (Ptr< const SpectrumModel > sm)
 SpectrumValue constructor. More...
 
 SpectrumValue ()
 
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)
 Multiply *this by the Right Hand Side of the operator, component by component. More...
 
SpectrumValue & operator*= (double rhs)
 Multiply every component of *this by the value of the Right Hand Side of the operator. More...
 
SpectrumValue & operator+= (const SpectrumValue &rhs)
 Add the Right Hand Side of the operator to *this, component by component. More...
 
SpectrumValue & operator+= (double rhs)
 Add the value of the Right Hand Side of the operator to all components of *this. More...
 
SpectrumValue & operator-= (const SpectrumValue &rhs)
 Subtract the Right Hand Side of the operator from *this, component by component. More...
 
SpectrumValue & operator-= (double rhs)
 Subtract the value of the Right Hand Side of the operator from all components of *this. More...
 
SpectrumValue & operator/= (const SpectrumValue &rhs)
 Divide *this by the Right Hand Side of the operator, component by component. More...
 
SpectrumValue & operator/= (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...
 
SpectrumValue & operator= (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...
 
double & operator[] (size_t index)
 Access value at given frequency index. More...
 
const double & operator[] (size_t index) const
 Access value at given frequency index. More...
 
Values::iterator ValuesBegin ()
 
Values::iterator ValuesEnd ()
 
- Public Member Functions inherited from ns3::SimpleRefCount< SpectrumValue >
 SimpleRefCount ()
 Constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCount & operator= (const SimpleRefCount &o)
 Assignment. 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)
 
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
 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+ (double lhs, const SpectrumValue &rhs)
 addition operator More...
 
SpectrumValue operator+ (const SpectrumValue &rhs)
 unary plus 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- (double lhs, const SpectrumValue &rhs)
 subtraction operator More...
 
SpectrumValue operator- (const SpectrumValue &rhs)
 unary minus 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)
 

Additional Inherited Members

- Static Public Member Functions inherited from ns3::SimpleRefCount< SpectrumValue >
static void Cleanup (void)
 Noop. More...
 

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

ns3::SpectrumValue::SpectrumValue ( )

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

Member Function Documentation

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

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

References m_spectrumModel, m_values, and NS_ASSERT.

Referenced by ns3::operator+(), operator+=(), ns3::operator-(), and Subtract().

+ Here is the caller graph for this function:

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

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

References m_values, and s.

void ns3::SpectrumValue::ChangeSign ( )
private

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

References m_values.

Referenced by ns3::operator-().

+ Here is the caller graph for this function:

Bands::const_iterator ns3::SpectrumValue::ConstBandsBegin ( ) const
Returns
a const iterator pointing to the beginning of the embedded SpectrumModel

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

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

Referenced by ns3::ConstantSpectrumPropagationLossModel::DoCalcRxPowerSpectralDensity(), ns3::FriisSpectrumPropagationLossModel::DoCalcRxPowerSpectralDensity(), ns3::ShannonSpectrumErrorModel::EvaluateChunk(), ns3::Integral(), and ns3::WriteAveragePowerSpectralDensityReport().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

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

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

Referenced by ns3::ConstantSpectrumPropagationLossModel::DoCalcRxPowerSpectralDensity(), ns3::FriisSpectrumPropagationLossModel::DoCalcRxPowerSpectralDensity(), ns3::ShannonSpectrumErrorModel::EvaluateChunk(), ns3::Integral(), and ns3::WriteAveragePowerSpectralDensityReport().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Values::const_iterator ns3::SpectrumValue::ConstValuesBegin ( ) const
Returns
a const iterator pointing to the beginning of the embedded SpectrumModel

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

References m_values.

Referenced by ns3::LteAmc::CreateCqiFeedbacks(), ns3::LteEnbPhy::CreatePuschCqiReport(), ns3::LteEnbPhy::CreateSrsCqiReport(), LteFrTestCase::DlDataRxStart(), LteFrAreaTestCase::DlDataRxStart(), ns3::ShannonSpectrumErrorModel::EvaluateChunk(), ns3::LteUePhy::GenerateCtrlCqiReport(), ns3::LteUePhy::GenerateMixedCqiReport(), ns3::Integral(), ns3::Norm(), ns3::operator<<(), ns3::Prod(), ns3::LteUePhy::ReceivePss(), ns3::LteUePhy::ReportRsReceivedPower(), ns3::Sum(), LteFrTestCase::UlDataRxStart(), LteFrAreaTestCase::UlDataRxStart(), and ns3::WriteAveragePowerSpectralDensityReport().

+ Here is the caller graph for this function:

Values::const_iterator ns3::SpectrumValue::ConstValuesEnd ( ) const
Returns
a const iterator pointing to the end of the embedded SpectrumModel

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

References m_values.

Referenced by ns3::LteAmc::CreateCqiFeedbacks(), ns3::LteEnbPhy::CreatePuschCqiReport(), ns3::LteEnbPhy::CreateSrsCqiReport(), LteFrTestCase::DlDataRxStart(), LteFrAreaTestCase::DlDataRxStart(), ns3::ShannonSpectrumErrorModel::EvaluateChunk(), ns3::LteUePhy::GenerateCtrlCqiReport(), ns3::LteUePhy::GenerateMixedCqiReport(), ns3::Integral(), ns3::Norm(), ns3::operator<<(), ns3::Prod(), ns3::LteUePhy::ReceivePss(), ns3::LteUePhy::ReportRsReceivedPower(), ns3::Sum(), LteFrTestCase::UlDataRxStart(), LteFrAreaTestCase::UlDataRxStart(), and ns3::WriteAveragePowerSpectralDensityReport().

+ Here is the caller graph for this function:

Ptr< SpectrumValue > ns3::SpectrumValue::Copy ( void  ) const
Returns
a Ptr to a copy of this instance

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

References m_spectrumModel.

Referenced by ns3::LrWpanInterferenceHelper::GetSignalPsd(), and ns3::SpectrumSignalParameters::SpectrumSignalParameters().

+ Here is the caller graph for this function:

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

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

References m_spectrumModel, m_values, and NS_ASSERT.

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

+ Here is the caller graph for this function:

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

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

References m_values, NS_LOG_FUNCTION, and s.

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

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

References m_values, and NS_LOG_FUNCTION.

Referenced by ns3::Pow().

+ Here is the caller graph for this function:

Ptr< const SpectrumModel > ns3::SpectrumValue::GetSpectrumModel ( void  ) const
Returns
the embedded SpectrumModel

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

References m_spectrumModel.

Referenced by SpectrumValueTestCase::DoRun(), ns3::LteTestSinrChunkProcessor::EvaluateChunk(), ns3::LteChunkProcessor::EvaluateChunk(), ns3::SpectrumAnalyzer::GenerateReport(), ns3::HalfDuplexIdealPhy::GetRxSpectrumModel(), and ns3::LrWpanPhy::GetRxSpectrumModel().

+ Here is the caller graph for this function:

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

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

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

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::SpectrumValue::Log ( )
private

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

References m_values, and NS_LOG_FUNCTION.

void ns3::SpectrumValue::Log10 ( )
private

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

References m_values, and NS_LOG_FUNCTION.

void ns3::SpectrumValue::Log2 ( )
private

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

References m_values, and NS_LOG_FUNCTION.

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

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

References m_spectrumModel, m_values, and NS_ASSERT.

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

+ Here is the caller graph for this function:

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

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

References m_values, and s.

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

References Multiply().

+ Here is the call graph for this function:

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

References Multiply().

+ Here is the call graph for this function:

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

References Add().

+ Here is the call graph for this function:

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

References Add().

+ Here is the call graph for this function:

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

References Subtract().

+ Here is the call graph for this function:

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

References Subtract().

+ Here is the call graph for this function:

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

References Divide().

+ Here is the call graph for this function:

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

References Divide().

+ Here is the call graph for this function:

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

References ShiftLeft().

+ Here is the call graph for this function:

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

References m_values.

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

References ShiftRight().

+ Here is the call graph for this function:

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

References m_values.

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

References m_values.

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

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

References m_values, and NS_LOG_FUNCTION.

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

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

References m_values.

Referenced by operator<<().

+ Here is the caller graph for this function:

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

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

References m_values.

Referenced by operator>>().

+ Here is the caller graph for this function:

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

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

References m_spectrumModel, m_values, and NS_ASSERT.

Referenced by ns3::operator-(), and operator-=().

+ Here is the caller graph for this function:

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

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

References Add().

+ Here is the call graph for this function:

Values::iterator ns3::SpectrumValue::ValuesBegin ( )
Returns
an iterator pointing to the beginning of the embedded SpectrumModel

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

References m_values.

Referenced by ns3::SpectrumConverter::Convert(), ns3::ConstantSpectrumPropagationLossModel::DoCalcRxPowerSpectralDensity(), ns3::FriisSpectrumPropagationLossModel::DoCalcRxPowerSpectralDensity(), ns3::TraceFadingLossModel::DoCalcRxPowerSpectralDensity(), and ns3::LteMiErrorModel::GetPcfichPdcchError().

+ Here is the caller graph for this function:

Values::iterator ns3::SpectrumValue::ValuesEnd ( )
Returns
an iterator pointing to the end of the embedded SpectrumModel

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

References m_values.

Referenced by ns3::SpectrumConverter::Convert(), ns3::ConstantSpectrumPropagationLossModel::DoCalcRxPowerSpectralDensity(), ns3::FriisSpectrumPropagationLossModel::DoCalcRxPowerSpectralDensity(), ns3::TraceFadingLossModel::DoCalcRxPowerSpectralDensity(), and ns3::LteMiErrorModel::GetPcfichPdcchError().

+ Here is the caller graph for this function:

Friends And Related Function Documentation

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

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

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

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

Referenced by ns3::Log().

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

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

Referenced by ns3::Log10().

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

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

Referenced by ns3::Log2().

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

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

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

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

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

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

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

SpectrumValue operator+ ( const SpectrumValue &  rhs)
friend

unary plus operator

Returns
the value of *this

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

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

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

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

SpectrumValue operator- ( const SpectrumValue &  rhs)
friend

unary minus operator

Returns
the value of - *this

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

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

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

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

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

Referenced by ns3::Pow().

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

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

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

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

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

Member Data Documentation

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

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

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

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

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

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