com.opttek.optquest
Class COptNeuralNetArc

java.lang.Object
  com.opttek.optquest.COptNeuralNetArc

public class COptNeuralNetArc

extends java.lang.Object

The COptNeuralNetArc is used to create arcs for an OptQuest Neural Network. These arcs are added to the COptNeuralNet to create the OptQuest Neural Network. Nodes are defined by a unique arc number, a from node, a to node, and a weight.

Constructor Summary

COptNeuralNetArc()
Default Constructor.

COptNeuralNetArc(int arcNumber, int fromNode, int toNode, double weight)
Constructor that accepts the type, node number and level as input.

Method Summary

void	FixNodeByUser(boolean fixed) FixNodeByUser() fixes (or unfixes) the node.
int	GetArcNumber() GetArcNumber() returns the arc number of this arc
int	GetFromNodeNumber() GetFromNodeNumber() returns the node number this arc comes from
int	GetToNodeNumber() GetToNodeNumber() returns the node number this arc goes to
double	GetWeight() GetWeight() returns the current weight of this arc
boolean	IsFixedByUser() IsFixedByUser() returns whether or not the node is fixed.

Methods inherited from class java.lang.Object

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

Constructor Detail

COptNeuralNetArc

public COptNeuralNetArc()

Default Constructor. The arcNumber, fromNode, toNode, and weight - the weight of the arc must be set before this is a valid arc.

COptNeuralNetArc

public COptNeuralNetArc(int arcNumber,
                        int fromNode,
                        int toNode,
                        double weight)

Constructor that accepts the type, node number and level as input. Each node number must be unique within the network. The level is used to determine how the network is traversed

Parameters:

arcNumber - - the number of the arc.

fromNode - - the number of the node that this arc is from.

toNode - - the number of the node that this arc is to.

weight - - the weight of the arc.

Method Detail

GetArcNumber

public int GetArcNumber()

GetArcNumber() returns the arc number of this arc

Returns:

arc number

GetToNodeNumber

public int GetToNodeNumber()

GetToNodeNumber() returns the node number this arc goes to

Returns:

node number

GetFromNodeNumber

public int GetFromNodeNumber()

GetFromNodeNumber() returns the node number this arc comes from

Returns:

node number

GetWeight

public double GetWeight()

GetWeight() returns the current weight of this arc

Returns:

node number

FixNodeByUser

public void FixNodeByUser(boolean fixed)

FixNodeByUser() fixes (or unfixes) the node. Fixed nodes keep the weight assigned by the user and is not part of any optimization.

Parameters:

fixed - - whether to fix (true) or unfix (false) the node.

IsFixedByUser

public boolean IsFixedByUser()

IsFixedByUser() returns whether or not the node is fixed.

Returns:

true/false - whether or not the node is fixed.