org.encog
Class Encog

java.lang.Object
  org.encog.Encog

public final class Encog
extends Object

Main Encog class, does little more than provide version information. Also used to hold the ORM session that Encog uses to work with Hibernate.

Author:

jheaton

Field Summary

static double	DEFAULT_DOUBLE_EQUAL Default point at which two doubles are equal.
static int	DEFAULT_PRECISION The default precision to use for compares.
static String	ENCOG_FILE_VERSION The encog file version.
static String	ENCOG_VERSION The version of the Encog JAR we are working with.
static String	VERSION The current engog version, this should be read from the properties.

Method Summary

EncogCL	getCL()
static Encog	getInstance() Get the instance to the singleton.
Map<String,String>	getProperties()
void	initCL() Enable OpenCL processing.
void	shutdown() Provides any shutdown that Encog may need.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VERSION

public static final String VERSION

The current engog version, this should be read from the properties.

See Also:

Constant Field Values

DEFAULT_PRECISION

public static final int DEFAULT_PRECISION

The default precision to use for compares.

See Also:

Constant Field Values

DEFAULT_DOUBLE_EQUAL

public static final double DEFAULT_DOUBLE_EQUAL

Default point at which two doubles are equal.

See Also:

Constant Field Values

ENCOG_VERSION

public static final String ENCOG_VERSION

The version of the Encog JAR we are working with. Given in the form x.x.x.

See Also:

Constant Field Values

ENCOG_FILE_VERSION

public static final String ENCOG_FILE_VERSION

The encog file version. This determines of an encog file can be read. This is simply an integer, that started with zero and is incremented each time the format of the encog data file changes.

See Also:

Constant Field Values

Method Detail

getInstance

public static Encog getInstance()

Get the instance to the singleton.

Returns:

The instance.

getProperties

public Map<String,String> getProperties()

Returns:

the properties

initCL

public void initCL()

Enable OpenCL processing. OpenCL processing allows Encog to use GPU devices to speed calculations. Not all areas of Encog can use this, however, GPU's can currently accelerate the training of Feedforward neural networks. To make use of the GPU you must have OpenCL drivers installed. For more information on getting OpenCL drivers, visit the following URL. http://www.heatonresearch.com/encog/opencl

shutdown

public void shutdown()

Provides any shutdown that Encog may need. Currently this shuts down the thread pool.

getCL

public EncogCL getCL()

Returns:

If Encog is not using GPU/CL processing this attribute will be null. Otherwise it holds the Encog CL object.