Specifies the parameters for the ScalarLayer More...

Inheritance diagram for MyCaffe.param.nt.ScalarParameter:

Public Types
enum	ScalarOp { MUL , ADD }
	Defines the scalar operations that may be performed. More...

Public Types inherited from MyCaffe.param.LayerParameterBase
enum	LABEL_TYPE { NONE , SINGLE , MULTIPLE , ONLY_ONE }
	Defines the label type. More...

Public Member Functions
	ScalarParameter ()
	The constructor. More...

override object	Load (System.IO.BinaryReader br, bool bNewInstance=true)
	Load the parameter from a binary reader. More...

override void	Copy (LayerParameterBase src)
	Copy on parameter to another. More...

override LayerParameterBase	Clone ()
	Creates a new copy of this instance of the parameter. More...

override RawProto	ToProto (string strName)
	Convert the parameter into a RawProto. More...

Public Member Functions inherited from MyCaffe.param.LayerParameterBase
	LayerParameterBase ()
	Constructor for the parameter. More...

virtual string	PrepareRunModelInputs ()
	This method gives derivative classes a chance specify model inputs required by the run model. More...

virtual void	PrepareRunModel (LayerParameter p)
	This method gives derivative classes a chance to prepare the layer for a run-model. More...

void	Save (BinaryWriter bw)
	Save this parameter to a binary writer. More...

abstract object	Load (BinaryReader br, bool bNewInstance=true)
	Load the parameter from a binary reader. More...

Public Member Functions inherited from MyCaffe.basecode.BaseParameter
	BaseParameter ()
	Constructor for the parameter. More...

virtual bool	Compare (BaseParameter p)
	Compare this parameter to another parameter. More...

Static Public Member Functions
static ScalarParameter	FromProto (RawProto rp)
	Parses the parameter from a RawProto. More...

Static Public Member Functions inherited from MyCaffe.basecode.BaseParameter
static double	ParseDouble (string strVal)
	Parse double values using the US culture if the decimal separator = '.', then using the native culture, and if then lastly trying the US culture to handle prototypes containing '.' as the separator, yet parsed in a culture that does not use '.' as a decimal. More...

static bool	TryParse (string strVal, out double df)
	Parse double values using the US culture if the decimal separator = '.', then using the native culture, and if then lastly trying the US culture to handle prototypes containing '.' as the separator, yet parsed in a culture that does not use '.' as a decimal. More...

static float	ParseFloat (string strVal)
	Parse float values using the US culture if the decimal separator = '.', then using the native culture, and if then lastly trying the US culture to handle prototypes containing '.' as the separator, yet parsed in a culture that does not use '.' as a decimal. More...

static bool	TryParse (string strVal, out float f)
	Parse doufloatble values using the US culture if the decimal separator = '.', then using the native culture, and if then lastly trying the US culture to handle prototypes containing '.' as the separator, yet parsed in a culture that does not use '.' as a decimal. More...

Properties
double	value `[getset]`
	Specifies the scalar value to apply. More...

ScalarOp	operation `[getset]`
	Specifies the scalar operation to apply (mul, add, etc). More...

bool	passthrough_gradient `[getset]`
	Specifies whether or not to pass-through the gradient without performing the back-prop calculation (default = false). More...

Detailed Description

Specifies the parameters for the ScalarLayer

Definition at line 15 of file ScalarParameter.cs.

Member Enumeration Documentation

◆ ScalarOp

enum MyCaffe.param.nt.ScalarParameter.ScalarOp

Defines the scalar operations that may be performed.

Enumerator
MUL	Specifies to run a mul_scalar on the layer.
ADD	Specifies to run an add_scalar on the layer.

Definition at line 24 of file ScalarParameter.cs.

Constructor & Destructor Documentation

◆ ScalarParameter()

MyCaffe.param.nt.ScalarParameter.ScalarParameter ( )

The constructor.

Definition at line 39 of file ScalarParameter.cs.

Member Function Documentation

◆ Clone()

override LayerParameterBase MyCaffe.param.nt.ScalarParameter.Clone ( )

virtual

Creates a new copy of this instance of the parameter.

Returns: A new instance of this parameter is returned.

Implements MyCaffe.param.LayerParameterBase.

Definition at line 105 of file ScalarParameter.cs.

◆ Copy()

override void MyCaffe.param.nt.ScalarParameter.Copy ( LayerParameterBase src )

virtual

Copy on parameter to another.

Parameters

src	Specifies the parameter to copy.

Implements MyCaffe.param.LayerParameterBase.

Definition at line 93 of file ScalarParameter.cs.

◆ FromProto()

static ScalarParameter MyCaffe.param.nt.ScalarParameter.FromProto ( RawProto rp )

static

Parses the parameter from a RawProto.

Parameters

rp	Specifies the RawProto to parse.

Returns: A new instance of the parameter is returned.

Definition at line 133 of file ScalarParameter.cs.

◆ Load()

override object MyCaffe.param.nt.ScalarParameter.Load	(	System.IO.BinaryReader	br,
		bool	bNewInstance = `true`
	)

Load the parameter from a binary reader.

Parameters

br	Specifies the binary reader.
bNewInstance	When true a new instance is created (the default), otherwise the existing instance is loaded from the binary reader.

Returns: Returns an instance of the parameter.

Definition at line 78 of file ScalarParameter.cs.

◆ ToProto()

override RawProto MyCaffe.param.nt.ScalarParameter.ToProto ( string strName )

virtual

Convert the parameter into a RawProto.

Parameters

strName Specifies the name to associate with the RawProto.

Returns: The new RawProto is returned.

Implements MyCaffe.basecode.BaseParameter.

Definition at line 117 of file ScalarParameter.cs.

Property Documentation

◆ operation

ScalarOp MyCaffe.param.nt.ScalarParameter.operation

getset

Specifies the scalar operation to apply (mul, add, etc).

Definition at line 57 of file ScalarParameter.cs.

◆ passthrough_gradient

bool MyCaffe.param.nt.ScalarParameter.passthrough_gradient

getset

Specifies whether or not to pass-through the gradient without performing the back-prop calculation (default = false).

Definition at line 66 of file ScalarParameter.cs.

◆ value

double MyCaffe.param.nt.ScalarParameter.value

getset

Specifies the scalar value to apply.

Definition at line 47 of file ScalarParameter.cs.

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

C:/Data/Data/SS_Projects/Intelligence/GitHub/MyCaffe/MyCaffe/param.nt/ScalarParameter.cs

Public Types

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ ScalarOp

Constructor & Destructor Documentation

◆ ScalarParameter()

Member Function Documentation

◆ Clone()

◆ Copy()

◆ FromProto()

◆ Load()

◆ ToProto()

Property Documentation

◆ operation

◆ passthrough_gradient

◆ value