MyCaffe  1.11.8.27
Deep learning software for Windows C# programmers.
MyCaffe.basecode.descriptors.ParameterDescriptorCollection Class Reference

The ParameterDescriptorCollection class contains a list of ParameterDescriptor's. More...

Inheritance diagram for MyCaffe.basecode.descriptors.ParameterDescriptorCollection:

Public Member Functions

 ParameterDescriptorCollection ()
 The ParameterDescriptorCollection constructor. More...
 
 ParameterDescriptorCollection (ParameterDescriptorCollection rg)
 The ParameterDescriptorCollection constructor. More...
 
void Add (ParameterDescriptor p)
 Adds a ParameterDescriptor to the collection. More...
 
ParameterDescriptor Find (string strName)
 Searches for a parameter by name in the collection. More...
 
string Find (string strName, string strDefault)
 Searches for a parameter by name and returns its string value if found, or a default string value if not. More...
 
double Find (string strName, double dfDefault)
 Searches for a parameter by name and returns its value as a double if found, or a default double value if not. More...
 
bool Find (string strName, bool bDefault)
 Searches for a parameter by name and returns its value as a bool if found, or a default bool value if not. More...
 
IEnumerator< ParameterDescriptorGetEnumerator ()
 Returns the enumerator of the collection. More...
 

Properties

int Count [get]
 Returns the count of items in the collection. More...
 
ParameterDescriptor this[int nIdx] [get]
 Returns the item at a given index within the collection. More...
 

Detailed Description

The ParameterDescriptorCollection class contains a list of ParameterDescriptor's.

Definition at line 14 of file ParameterDescriptorCollection.cs.

Constructor & Destructor Documentation

◆ ParameterDescriptorCollection() [1/2]

MyCaffe.basecode.descriptors.ParameterDescriptorCollection.ParameterDescriptorCollection ( )

The ParameterDescriptorCollection constructor.

Definition at line 22 of file ParameterDescriptorCollection.cs.

◆ ParameterDescriptorCollection() [2/2]

MyCaffe.basecode.descriptors.ParameterDescriptorCollection.ParameterDescriptorCollection ( ParameterDescriptorCollection  rg)

The ParameterDescriptorCollection constructor.

Parameters
rgSpecifies another collection used to create this one.

Definition at line 30 of file ParameterDescriptorCollection.cs.

Member Function Documentation

◆ Add()

void MyCaffe.basecode.descriptors.ParameterDescriptorCollection.Add ( ParameterDescriptor  p)

Adds a ParameterDescriptor to the collection.

Parameters
pSpecifies the item to add.

Definition at line 61 of file ParameterDescriptorCollection.cs.

◆ Find() [1/4]

ParameterDescriptor MyCaffe.basecode.descriptors.ParameterDescriptorCollection.Find ( string  strName)

Searches for a parameter by name in the collection.

Parameters
strNameSpecifies the name to look for.
Returns
If found, the item is returned, otherwise null is returned.

Definition at line 72 of file ParameterDescriptorCollection.cs.

◆ Find() [2/4]

bool MyCaffe.basecode.descriptors.ParameterDescriptorCollection.Find ( string  strName,
bool  bDefault 
)

Searches for a parameter by name and returns its value as a bool if found, or a default bool value if not.

Parameters
strNameSpecifies the name to look for.
bDefaultSpecifies the default value to return if not found.
Returns
The bool value of the named parameter is returned if found, otherwise the default bool value is returned.

Definition at line 117 of file ParameterDescriptorCollection.cs.

◆ Find() [3/4]

double MyCaffe.basecode.descriptors.ParameterDescriptorCollection.Find ( string  strName,
double  dfDefault 
)

Searches for a parameter by name and returns its value as a double if found, or a default double value if not.

Parameters
strNameSpecifies the name to look for.
dfDefaultSpecifies the default value to return if not found.
Returns
The double value of the named parameter is returned if found, otherwise the default double value is returned.

Definition at line 102 of file ParameterDescriptorCollection.cs.

◆ Find() [4/4]

string MyCaffe.basecode.descriptors.ParameterDescriptorCollection.Find ( string  strName,
string  strDefault 
)

Searches for a parameter by name and returns its string value if found, or a default string value if not.

Parameters
strNameSpecifies the name to look for.
strDefaultSpecifies the default value to return if not found.
Returns
The string value of the named parameter is returned if found, otherwise the default string value is returned.

Definition at line 87 of file ParameterDescriptorCollection.cs.

◆ GetEnumerator()

IEnumerator< ParameterDescriptor > MyCaffe.basecode.descriptors.ParameterDescriptorCollection.GetEnumerator ( )

Returns the enumerator of the collection.

Returns
The collection's enumerator is returned.

Definition at line 130 of file ParameterDescriptorCollection.cs.

Property Documentation

◆ Count

int MyCaffe.basecode.descriptors.ParameterDescriptorCollection.Count
get

Returns the count of items in the collection.

Definition at line 42 of file ParameterDescriptorCollection.cs.

◆ this[int nIdx]

ParameterDescriptor MyCaffe.basecode.descriptors.ParameterDescriptorCollection.this[int nIdx]
get

Returns the item at a given index within the collection.

Parameters
nIdxSpecifies the index.
Returns
Returns the item as the index.

Definition at line 52 of file ParameterDescriptorCollection.cs.


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