hops::MHO_NormFX Class Reference

Class MHO_NormFX. More...

#include <MHO_NormFX.hh>

Inheritance diagram for hops::MHO_NormFX:

Public Member Functions
	MHO_NormFX ()
virtual	~MHO_NormFX ()
void	SetWeights (weight_type *w)
	Setter for weights. More...
Public Member Functions inherited from hops::MHO_UnaryOperator< visibility_type >
	MHO_UnaryOperator ()
virtual	~MHO_UnaryOperator ()
virtual bool	Execute () override
	Executes operation using provided arguments and return type. More...
virtual bool	Execute () override=0
	Function Execute. More...
virtual bool	Initialize () override
	Initializes the system using in-place or out-of-place arguments. More...
virtual bool	Initialize () override=0
	Function Initialize. More...
	MHO_Operator ()
virtual void	SetArgs (const visibility_type *in, visibility_type *out)
	Setter for args. More...
virtual void	SetArgs (visibility_type *in)
	Setter for args. More...
Public Member Functions inherited from hops::MHO_Operator
	MHO_Operator ()
virtual	~MHO_Operator ()
std::string	GetName () const
	Getter for operator name. More...
virtual double	Priority () const
	Get the the priority field value. More...
void	SetName (std::string name)
	Setter for operator name. More...
virtual void	SetPriority (const double &priority)
	Setter for operator priority (determines order of execution within a operator category) More...

Protected Types
using	XArgType = visibility_type

Protected Member Functions
virtual bool	ExecuteInPlace (XArgType *in)=0
	Function ExecuteInPlace. More...
virtual bool	ExecuteOutOfPlace (const XArgType *in, XArgType *out)=0
	Function ExecuteOutOfPlace. More...
virtual bool	InitializeInPlace (XArgType *in)=0
	Function InitializeInPlace. More...
virtual bool	InitializeOutOfPlace (const XArgType *in, XArgType *out)=0
	Function InitializeOutOfPlace. More...

Protected Attributes
weight_type *	fWeights
Protected Attributes inherited from hops::MHO_UnaryOperator< visibility_type >
bool	fInPlace
std::tuple< visibility_type * >	fInPlaceArgs
std::tuple< const visibility_type *, visibility_type * >	fOutOfPlaceArgs

Detailed Description

Class MHO_NormFX.

wrapper class for the interface which provides the functionality of the original norm_fx.c operation this is a unary operator on visibilities that accepts weights

Author

J. Barrett - barre.nosp@m.ttj@.nosp@m.mit.e.nosp@m.du

Date

Fri Jul 9 11:47:00 2021 -0400

Member Typedef Documentation

XArgType

using hops::MHO_NormFX::XArgType = visibility_type

protected

Constructor & Destructor Documentation

MHO_NormFX()

hops::MHO_NormFX::MHO_NormFX ( )

inline

~MHO_NormFX()

virtual hops::MHO_NormFX::~MHO_NormFX ( )

inlinevirtual

Member Function Documentation

ExecuteInPlace()

virtual bool hops::MHO_NormFX::ExecuteInPlace ( XArgType *  in )

protectedpure virtual

Function ExecuteInPlace.

Parameters

in	(XArgType*)

Returns

Return value (bool)

Note

This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

Implemented in hops::MHO_SingleSidebandNormFX, and hops::MHO_MixedSidebandNormFX.

ExecuteOutOfPlace()

virtual bool hops::MHO_NormFX::ExecuteOutOfPlace ( const XArgType *  in, XArgType *  out  )

protectedpure virtual

Function ExecuteOutOfPlace.

Parameters

in	(const XArgType*)
out	(XArgType*)

Returns

Return value (bool)

Note

This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

Implemented in hops::MHO_SingleSidebandNormFX, and hops::MHO_MixedSidebandNormFX.

InitializeInPlace()

virtual bool hops::MHO_NormFX::InitializeInPlace ( XArgType *  in )

protectedpure virtual

Function InitializeInPlace.

Parameters

in	(XArgType*)

Returns

Return value (bool)

Note

This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

Implemented in hops::MHO_SingleSidebandNormFX, and hops::MHO_MixedSidebandNormFX.

InitializeOutOfPlace()

virtual bool hops::MHO_NormFX::InitializeOutOfPlace ( const XArgType *  in, XArgType *  out  )

protectedpure virtual

Function InitializeOutOfPlace.

Parameters

in	(const XArgType*)
out	(XArgType*)

Returns

Return value (bool)

Note

This is a virtual function.

Implements hops::MHO_UnaryOperator< visibility_type >.

Implemented in hops::MHO_SingleSidebandNormFX, and hops::MHO_MixedSidebandNormFX.

SetWeights()

void hops::MHO_NormFX::SetWeights ( weight_type *  w )

inline

Setter for weights.

Parameters

w	Input pointer to weight_type array

Member Data Documentation

fWeights

weight_type* hops::MHO_NormFX::fWeights

protected

---

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

• MHO_NormFX.hh