dag

Class HighCapacityDagLevel

java.lang.Object

dag.HighCapacityDagLevel

All Implemented Interfaces:

DagLevel

public final class HighCapacityDagLevel
extends java.lang.Object
implements DagLevel

Class HighCapacityDagLevel represents a level of a leveled directed acyclic graph (DAG) that can contain up to Integer.MAX_VALUE edges.

Instances of HighCapacityDagLevel are immutable.

Constructor Summary

Constructors

Constructor and Description
HighCapacityDagLevel(int[] parentNodes, int[] childNodes, int[] symbols, float[] counts) Constructs a new HighCapacityDagLevel instance from the specified data.

Method Summary

Modifier and Type	Method and Description
int	childNode(int edge) Returns the index of the child node of the specified edge at this level of the DAG.
float	condEdgeProb(int edge) Returns the conditional edge probability, which is defined to be the ratio of the sum of the weights of the sequences that pass through the specified edge at this level of the DAG and the sum of the weights of the sequences that pass through the parent node of the specified edge.
float	edgeProb(int edge) Returns the edge probability, which is defined to be the ratio of the sum of the weights of the sequences that pass through the specified edge at this level of the DAG and the sum of the weights of the sequences that pass through any edge at this level of the DAG.
float	edgeWeight(int edge) Returns the sum of weights for the sequences that pass through the specified edge at this level of the DAG.
int	inEdge(int childNode, int inEdgeIndex) Returns the index of the specified edge at this level of the DAG.
int	nChildNodes() Returns the number of child nodes at this level of the DAG.
int	nEdges() Returns the number of edges at this level of the DAG.
int	nInEdges(int childNode) Returns the number of ingoing edges for the specified child node at this level of the DAG.
int	nOutEdges(int parentNode) Returns the number of outgoing edges of the specified parent node at this level of the DAG.
int	nParentNodes() Returns the number of parent nodes at this level of the DAG.
int	outEdge(int parentNode, int outEdgeIndex) Returns the index of the specified edge at this level of the DAG.
int	outEdgeBySymbol(int parentNode, int symbol) Returns the index of the specified edge at this level of the DAG or -1 if no such edge exists.
int	parentNode(int edge) Returns the index of the parent node of the specified edge at this level of the DAG.
float	parentProb(int node) Returns the parent node probability, which is defined to be the ratio of the sum of the weights of the sequences that pass through the specified parent node at this level of the DAG and the sum of the weights of the sequences that pass through any parent node at this level of the DAG.
float	parentWeight(int parentNode) Returns the sum of weights for the sequences that pass through the specified node at this level of the DAG.
int	symbol(int edge) Returns the symbol labeling the specified edge at this level of the DAG.
java.lang.String	toString() Returns a string representation of this.

Methods inherited from class java.lang.Object

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

Constructor Detail

HighCapacityDagLevel

public HighCapacityDagLevel(int[] parentNodes,
                            int[] childNodes,
                            int[] symbols,
                            float[] counts)

Constructs a new HighCapacityDagLevel instance from the specified data.

Parameters:

parentNodes - an array mapping edge index to parent node index

childNodes - an array mapping edge index to child node index

symbols - an array mapping edge index to the symbol labeling the edge

counts - an array mapping edge index to edge count

Throws:

java.lang.IllegalArgumentException - if the specified arrays do not all have the same length

java.lang.IllegalArgumentException - if any element of the symbols array is negative

java.lang.IllegalArgumentException - if any two edges have the same parent node and are both labeled with the same symbol

java.lang.IllegalArgumentException - if the set of values of the parentNodes array is not equal to {0, 1, 2, ..., k} for some k

java.lang.IllegalArgumentException - if the set of values of the childNodes array is not equal to {0, 1, 2, ..., k} for some k

java.lang.NullPointerException - if any parameter is null

Method Detail

nEdges

public int nEdges()

Description copied from interface: DagLevel

Returns the number of edges at this level of the DAG.

Specified by:

nEdges in interface DagLevel

Returns:

the number of edges at this level of the DAG

nParentNodes

public int nParentNodes()

Description copied from interface: DagLevel

Returns the number of parent nodes at this level of the DAG.

Specified by:

nParentNodes in interface DagLevel

Returns:

the number of parent nodes at this level of the DAG

nChildNodes

public int nChildNodes()

Description copied from interface: DagLevel

Returns the number of child nodes at this level of the DAG.

Specified by:

nChildNodes in interface DagLevel

Returns:

the number of child nodes at this level of the DAG

parentNode

public int parentNode(int edge)

Description copied from interface: DagLevel

Returns the index of the parent node of the specified edge at this level of the DAG.

Specified by:

parentNode in interface DagLevel

Parameters:

edge - an edge index

Returns:

the index of the parent node of the specified edge at this level of the DAG

childNode

public int childNode(int edge)

Description copied from interface: DagLevel

Returns the index of the child node of the specified edge at this level of the DAG.

Specified by:

childNode in interface DagLevel

Parameters:

edge - an edge index.

Returns:

the index of the child node of the specified edge at this level of the DAG.

symbol

public int symbol(int edge)

Description copied from interface: DagLevel

Returns the symbol labeling the specified edge at this level of the DAG.

Specified by:

symbol in interface DagLevel

Parameters:

edge - an edge index

Returns:

the symbol labeling the specified edge at this level of the DAG

edgeWeight

public float edgeWeight(int edge)

Description copied from interface: DagLevel

Returns the sum of weights for the sequences that pass through the specified edge at this level of the DAG.

Specified by:

edgeWeight in interface DagLevel

Parameters:

edge - an edge index

Returns:

the sum of weights for the sequences that pass through the specified edge at this level of the DAG

parentWeight

public float parentWeight(int parentNode)

Description copied from interface: DagLevel

Returns the sum of weights for the sequences that pass through the specified node at this level of the DAG.

Specified by:

parentWeight in interface DagLevel

Parameters:

parentNode - a parent node index

Returns:

the sum of weights for the sequences that pass through the specified node at this level of the DAG

condEdgeProb

public float condEdgeProb(int edge)

Description copied from interface: DagLevel

Returns the conditional edge probability, which is defined to be the ratio of the sum of the weights of the sequences that pass through the specified edge at this level of the DAG and the sum of the weights of the sequences that pass through the parent node of the specified edge.

Specified by:

condEdgeProb in interface DagLevel

Parameters:

edge - an edge index

Returns:

the conditional edge probability

edgeProb

public float edgeProb(int edge)

Description copied from interface: DagLevel

Returns the edge probability, which is defined to be the ratio of the sum of the weights of the sequences that pass through the specified edge at this level of the DAG and the sum of the weights of the sequences that pass through any edge at this level of the DAG.

Specified by:

edgeProb in interface DagLevel

Parameters:

edge - an edge index

Returns:

the edge probability

parentProb

public float parentProb(int node)

Description copied from interface: DagLevel

Returns the parent node probability, which is defined to be the ratio of the sum of the weights of the sequences that pass through the specified parent node at this level of the DAG and the sum of the weights of the sequences that pass through any parent node at this level of the DAG.

Specified by:

parentProb in interface DagLevel

Parameters:

node - a parent node index

Returns:

the parent node probability

nOutEdges

public int nOutEdges(int parentNode)

Description copied from interface: DagLevel

Returns the number of outgoing edges of the specified parent node at this level of the DAG.

Specified by:

nOutEdges in interface DagLevel

Parameters:

parentNode - a parent node index

Returns:

the number of outgoing edges of the specified parent node at this level of the DAG

outEdge

public int outEdge(int parentNode,
                   int outEdgeIndex)

Description copied from interface: DagLevel

Returns the index of the specified edge at this level of the DAG.

Specified by:

outEdge in interface DagLevel

Parameters:

parentNode - a parent node index

outEdgeIndex - the index of the outgoing edge of the specified parent node

Returns:

the index of the specified edge at this level of the DAG

outEdgeBySymbol

public int outEdgeBySymbol(int parentNode,
                           int symbol)

Description copied from interface: DagLevel

Returns the index of the specified edge at this level of the DAG or -1 if no such edge exists.

Specified by:

outEdgeBySymbol in interface DagLevel

Parameters:

parentNode - a parent node index

symbol - a symbol labeling an outgoing edge of the specified parent node

Returns:

the index of the specified edge at this level of the DAG or -1 if no such edge exists

nInEdges

public int nInEdges(int childNode)

Description copied from interface: DagLevel

Returns the number of ingoing edges for the specified child node at this level of the DAG.

Specified by:

nInEdges in interface DagLevel

Parameters:

childNode - a child node index

Returns:

the number of ingoing edges for the specified child node at this level of the DAG

inEdge

public int inEdge(int childNode,
                  int inEdgeIndex)

Description copied from interface: DagLevel

Returns the index of the specified edge at this level of the DAG.

Specified by:

inEdge in interface DagLevel

Parameters:

childNode - index of the child node

inEdgeIndex - index of an ingoing edge of the specified child node

Returns:

the index of the specified edge at this level of the DAG

toString

public java.lang.String toString()

Description copied from interface: DagLevel

Returns a string representation of this. The exact details of the representation are unspecified and subject to change.

Specified by:

toString in interface DagLevel

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this