C# Class Encog.Persist.EncogPersistedCollection

An EncogPersistedCollection holds a collection of EncogPersistedObjects. This allows the various neural networks and some data sets to be persisted. They are persisted to an XML form. The EncogPersistedCollection does not load the object into memory at once. This allows it to manage large files.
Inheritance: IEncogCollection
Show file Open project: encog/encog-silverlight-core

Public Methods

Method Description
Add ( String name, IEncogPersistedObject obj ) : void

Add an EncogPersistedObject to the collection.
BuildDirectory ( ) : void

Build a directory of objects.
Clear ( ) : void

Clear the collection.
Create ( ) : void

Create the file.
Delete ( DirectoryEntry d ) : void

Delete the specified object, use a directory entry.
Delete ( IEncogPersistedObject obj ) : void

Delete the specified object.
Delete ( String name ) : void

Delete the specified object.
EncogPersistedCollection ( IPersistenceLocation location, FileMode mode ) : System

Create an object based on the specified location.
EncogPersistedCollection ( String file, FileMode mode ) : System

Create a persistance collection for the specified file.
Exists ( String name ) : bool

Determine if the specified resource exists.
Find ( DirectoryEntry d ) : IEncogPersistedObject

Find the specified object, using a DirectoryEntry.
Find ( String name ) : IEncogPersistedObject

Called to search all Encog objects in this collection for one with a name that passes what was passed in.
MergeTemp ( ) : void

Merge the temp file with the main one, call this to make any changes permanent.
ThrowError ( String tag ) : void

Throw and log an error.
UpdateProperties ( String name, String newName, String newDesc ) : void

Update any header properties for an Encog object, for example, a rename.

Method Details

Add() public method

Add an EncogPersistedObject to the collection.
public Add ( String name, IEncogPersistedObject obj ) : void
name String The name of the object to load.
obj IEncogPersistedObject The object to add.
return void

BuildDirectory() public method

Build a directory of objects.
public BuildDirectory ( ) : void
return void

Clear() public method

Clear the collection.
public Clear ( ) : void
return void

Create() public method

Create the file.
public Create ( ) : void
return void

Delete() public method

Delete the specified object, use a directory entry.
public Delete ( DirectoryEntry d ) : void
d DirectoryEntry The object to delete.
return void

Delete() public method

Delete the specified object.
public Delete ( IEncogPersistedObject obj ) : void
obj IEncogPersistedObject The object to delete.
return void

Delete() public method

Delete the specified object.
public Delete ( String name ) : void
name String The object name.
return void

EncogPersistedCollection() public method

Create an object based on the specified location.
public EncogPersistedCollection ( IPersistenceLocation location, FileMode mode ) : System
location IPersistenceLocation The location to load/save from.
mode FileMode The file mode.
return System

EncogPersistedCollection() public method

Create a persistance collection for the specified file.
public EncogPersistedCollection ( String file, FileMode mode ) : System
file String The file to load/save.
mode FileMode The file mode
return System

Exists() public method

Determine if the specified resource exists.
public Exists ( String name ) : bool
name String The name of the resource to check.
return bool

Find() public method

Find the specified object, using a DirectoryEntry.
public Find ( DirectoryEntry d ) : IEncogPersistedObject
d DirectoryEntry The directory entry to find.
return IEncogPersistedObject

Find() public method

Called to search all Encog objects in this collection for one with a name that passes what was passed in.
public Find ( String name ) : IEncogPersistedObject
name String The name we are searching for.
return IEncogPersistedObject

MergeTemp() public method

Merge the temp file with the main one, call this to make any changes permanent.
public MergeTemp ( ) : void
return void

ThrowError() public static method

Throw and log an error.
public static ThrowError ( String tag ) : void
tag String The tag this error is for.
return void

UpdateProperties() public method

Update any header properties for an Encog object, for example, a rename.
public UpdateProperties ( String name, String newName, String newDesc ) : void
name String The name of the object to change.
newName String The new name of this object.
newDesc String The description for this object.
return void