org.cognity.neural.net

Interface NeuralNet

All Known Subinterfaces:

FeedforwardNet

All Known Implementing Classes:

AbstractFeedforwardNet, AbstractNeuralNet, MlpNet

public interface NeuralNet

The basic interface for a neural network. It provides basic methods for using the network and getting info about it's structure.

Author:

Artur Markiewicz

Method Summary

Methods

Modifier and Type	Method and Description
double[]	compute(double[] input) Performs computations for this network.
Layer	getInputLayer() Returns the input layer of this network.
Set<Link>	getInputLinks(Layer layer) Returns input links of the specified layer.
int	getInputSize() Returns the size of the input layer.
int	getLayerCount() Returns the number of all layers in this network.
Set<Layer>	getLayers() Returns a set of all layers in this network.
Set<Link>	getLinks() Returns a set of all links in this network.
Link	getOneInputLink(Layer layer) Returns one of input links of the specified layer.
Link	getOneOutputLink(Layer layer) Returns one of output links of the specified layer.
Layer	getOutputLayer() Returns the output layer of this network.
Set<Link>	getOutputLinks(Layer layer) Returns output links of the specified layer.
int	getOutputSize() Returns the size of the output layer.
boolean	hasInputLinks(Layer layer) Returns true if the specified layer has at least one input link.
boolean	hasOutputLinks(Layer layer) Returns true if the specified layer has at least one output link.

Method Detail

compute

double[] compute(double[] input)

Performs computations for this network.

Parameters:

input - The input vector. Cannot be null. The size of the vector must be equal to the size of the input layer.

Returns:

the output vector

getInputSize

int getInputSize()

Returns the size of the input layer.

Returns:

the size of the input layer

getOutputSize

int getOutputSize()

Returns the size of the output layer.

Returns:

the size of the output layer

getInputLayer

Layer getInputLayer()

Returns the input layer of this network.

Returns:

the input layer of this network

getOutputLayer

Layer getOutputLayer()

Returns the output layer of this network.

Returns:

the output layer of this network

hasInputLinks

boolean hasInputLinks(Layer layer)

Returns true if the specified layer has at least one input link.

Parameters:

layer - the examinated layer. Cannot be null.

Returns:

• true - if specified layer has at least one input link
• false - if specified layer has no input links, doesn't belong to this network

hasOutputLinks

boolean hasOutputLinks(Layer layer)

Returns true if the specified layer has at least one output link.

Parameters:

layer - the examinated layer. Cannot be null.

Returns:

• true - if specified layer has at least one output link
• false - if specified layer has no input links or doesn't belong to this network

getInputLinks

Set<Link> getInputLinks(Layer layer)

Returns input links of the specified layer. If the layer has no input links, then empty set is returned.

The returned set is immutable.

Parameters:

layer - the examinated layer. Cannot be null.

Returns:

• the immutable set of input links of the layer
• empty set - if the layer doesn't belong to this network

getOneInputLink

Link getOneInputLink(Layer layer)

Returns one of input links of the specified layer. If the layer has no input links, then null is returned.
This is a shortcut method. It's useful only if the layer has exactly one input link. It's not specified which link will be returned if the layer has more than one input link.

Parameters:

layer - the examinated layer. Cannot be null.

Returns:

• one of input links of the layer
• null - if the layer has no input links or doesn't belong to this network

getOutputLinks

Set<Link> getOutputLinks(Layer layer)

Returns output links of the specified layer. If the layer has no output links, then empty set is returned.

The returned set is immutable.

Parameters:

layer - the layer. Cannot be null.

Returns:

• the immutable set of output links of the layer
• empty set - if the layer doesn't belong to this network

getOneOutputLink

Link getOneOutputLink(Layer layer)

Returns one of output links of the specified layer. If the layer has no output links, then null is returned.
This is a shortcut method. It's useful only if the layer has exactly one output link. It's not specified which link will be returned if the layer has more than one output link.

Parameters:

layer - the layer. Cannot be null.

Returns:

• one of output links of the layer
• null - if the layer has no output links or doesn't belong to this network

getLayers

Set<Layer> getLayers()

Returns a set of all layers in this network.

The returned list is immutable.

Returns:

the immutable set of all layers

getLinks

Set<Link> getLinks()

Returns a set of all links in this network.

The returned set is immutable.

Returns:

the immutable set of all links

getLayerCount

int getLayerCount()

Returns the number of all layers in this network.

Returns:

the number of layers