MyCaffe.trainers.common.FileMemoryCollection Class Reference

The FileMemoryCollection is used during debugging to load from and save to file. More...

Inheritance diagram for MyCaffe.trainers.common.FileMemoryCollection:

Public Member Functions
	FileMemoryCollection (int nMax, bool bPreLoad, bool bSaveOnCleanup, string strFile)
	The constructor. More...
void	CleanUp ()
	Complete any final processing. More...
void	Add (MemoryItem mi)
	Add a new item to the collection. More...
MemoryCollection	GetSamples (CryptoRandom random, int nCount, double dfBeta)
	Return a batch of items. More...
void	Update (MemoryCollection rgSamples)
	Update - does nothing. More...

Properties
int	Count [get]
	Returns the number of items in the collection. More...
Properties inherited from MyCaffe.trainers.common.IMemoryCollection
int	Count [get]
	Returns the number of items in the memory collection. More...

Detailed Description

The FileMemoryCollection is used during debugging to load from and save to file.

Definition at line 14 of file FileMemoryCollection.cs.

Constructor & Destructor Documentation

FileMemoryCollection()

MyCaffe.trainers.common.FileMemoryCollection.FileMemoryCollection	(	int	nMax,
		bool	bPreLoad,
		bool	bSaveOnCleanup,
		string	strFile
	)

The constructor.

Parameters

nMax	Specifies the maximum number of items.
bPreLoad	Pre-load the data from file.
bSaveOnCleanup	Save the memory items on cleanup.
strFile	Specifies the name of the file to load from or save to.

Definition at line 32 of file FileMemoryCollection.cs.

Member Function Documentation

Add()

void MyCaffe.trainers.common.FileMemoryCollection.Add

(

MemoryItem

mi

)

Add a new item to the collection.

Parameters

mi	Specifies the item to add.

Implements MyCaffe.trainers.common.IMemoryCollection.

Definition at line 64 of file FileMemoryCollection.cs.

CleanUp()

void MyCaffe.trainers.common.FileMemoryCollection.CleanUp

(

)

Complete any final processing.

Implements MyCaffe.trainers.common.IMemoryCollection.

Definition at line 46 of file FileMemoryCollection.cs.

GetSamples()

MemoryCollection MyCaffe.trainers.common.FileMemoryCollection.GetSamples	(	CryptoRandom	random,
		int	nCount,
		double	dfBeta
	)

Return a batch of items.

Parameters

random	Specifies the random number generator.
nCount	Specifies the number of items to sample.
dfBeta	Not used.

Returns

The array of items is returned.

Implements MyCaffe.trainers.common.IMemoryCollection.

Definition at line 77 of file FileMemoryCollection.cs.

Update()

void MyCaffe.trainers.common.FileMemoryCollection.Update

(

MemoryCollection

rgSamples

)

Update - does nothing.

Parameters

rgSamples

Specifies the list of samples.

Implements MyCaffe.trainers.common.IMemoryCollection.

Definition at line 121 of file FileMemoryCollection.cs.

Property Documentation

Count

int MyCaffe.trainers.common.FileMemoryCollection.Count

get

Returns the number of items in the collection.

Definition at line 55 of file FileMemoryCollection.cs.

---

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

• C:/Data/Data/SS_Projects/Intelligence/GitHub/MyCaffe/MyCaffe.trainers/common/FileMemoryCollection.cs