nz.ac.waikato.mcennis.rat.graph.algorithm.transformToArray
Class DirectedTriplesHistogram

java.lang.Object
  nz.ac.waikato.mcennis.rat.graph.model.ModelShell
      nz.ac.waikato.mcennis.rat.graph.algorithm.transformToArray.DirectedTriplesHistogram

All Implemented Interfaces:

java.io.Serializable, Component, Algorithm, Model

public class DirectedTriplesHistogram
extends ModelShell
implements Algorithm

Transforms a graph object (one mode and relation) into a 20 dimensional double array describing a histogram of all triples of actors in the graph.
Links are classified in the following way:

• 0: no link exists
• 1: left->right link exists
• 2: right->left link exists
• 3: bi-directional link exists

This histogram created in the following way:
*

• 0: all three links are type 0
• 1: Three different types of links excluding type 3
• 2: Three different types of links excluding type 2
• 3: Three different types of links excluding type 1
• 4: Three different types of links excluding type 0
• 5: Two sides are of type 0, third side is of type 1
• 6: Two sides are of type 0, third side is of type 2
• 7: Two sides are of type 0, third side is of type 3
• 8: Two sides are of type 1, third side is of type 0
• 9: Two sides are of type 1, third side is of type 1
• 10: Two sides are of type 1, third side is of type 2
• 11: Two sides are of type 2, third side is of type 0
• 12: Two sides are of type 2, third side is of type 1
• 13: Two sides are of type 2, third side is of type 3
• 14: Two sides are of type 3, third side is of type 0
• 15: Two sides are of type 3, third side is of type 1
• 16: Two sides are of type 3, third side is of type 2
• 17: All three links are type 1
• 18: All three links are type 2
• 19: All three links are type 3

See Also:

Serialized Form

Field Summary

Fields inherited from class nz.ac.waikato.mcennis.rat.graph.model.ModelShell

listener

Constructor Summary

DirectedTriplesHistogram()

Method Summary

void	DirectedTriplesHistogram()
void	execute(Graph g) execute the algorithm against the given graph
InputDescriptor[]	getInputType() The input type describes all the different kinds of graph objects that are utilized (and hence required) by this object.
protected java.util.TreeSet<Actor>	getLinks(Graph g, Actor v, Actor comparator)
protected int	getLinkType(Graph g, Actor left, Actor right)
OutputDescriptor[]	getOutputType() The output type describes all the different kinds of graph objects that are created during the execution of this algorithm.
Parameter[]	getParameter() List of all parameters this component accepts.
Parameter	getParameter(java.lang.String param) Returns the specific parameter identified by its key-name.
SettableParameter[]	getSettableParameter() Returns settable (i.e.
SettableParameter	getSettableParameter(java.lang.String param) Return the settable parameter namede by this key-name.
void	init(java.util.Properties map) Parameters: name: name of this algorithm.
protected int	mapIndex(int first, int second, int third)
protected int	twoSidesMap(int twoSide, int oneSide)

Methods inherited from class nz.ac.waikato.mcennis.rat.graph.model.ModelShell

addListener, fireChange

Methods inherited from class java.lang.Object

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

Methods inherited from interface nz.ac.waikato.mcennis.rat.graph.model.Model

addListener

Constructor Detail

DirectedTriplesHistogram

public DirectedTriplesHistogram()

Method Detail

DirectedTriplesHistogram

public void DirectedTriplesHistogram()

execute

public void execute(Graph g)

Description copied from interface: Algorithm

execute the algorithm against the given graph

Specified by:

execute in interface Algorithm

Parameters:

g - graph to be modified

mapIndex

protected int mapIndex(int first,
                       int second,
                       int third)

twoSidesMap

protected int twoSidesMap(int twoSide,
                          int oneSide)

getLinkType

protected int getLinkType(Graph g,
                          Actor left,
                          Actor right)

getLinks

protected java.util.TreeSet<Actor> getLinks(Graph g,
                                            Actor v,
                                            Actor comparator)

getInputType

public InputDescriptor[] getInputType()

Description copied from interface: Component

The input type describes all the different kinds of graph objects that are utilized (and hence required) by this object. This result is only guaranteed to be fixed if structural parameters are not modified. This is an empty array if there is no input.

Specified by:

getInputType in interface Component

Returns:

InputDescriptor array for this component

See Also:

InputDescriptor

getOutputType

public OutputDescriptor[] getOutputType()

Description copied from interface: Component

The output type describes all the different kinds of graph objects that are created during the execution of this algorithm. The result is only guaranteed to be fixed if structural parameters are not modified. This is an empty array if there is no output.

Specified by:

getOutputType in interface Component

Returns:

OutputDescriptor array for this component

See Also:

OutputDescriptor

getParameter

public Parameter[] getParameter()

Description copied from interface: Component

List of all parameters this component accepts. Each parameter also has a distinct key-name used when initializing the object using the init method. If there are no parameters, null is returned.

Specified by:

getParameter in interface Component

Returns:

read-only array of Parameters

getParameter

public Parameter getParameter(java.lang.String param)

Description copied from interface: Component

Returns the specific parameter identified by its key-name. If no parameter is found with this key-name, null is returned.

Specified by:

getParameter in interface Component

Parameters:

param - key-name of the parameter

Returns:

named parameter

getSettableParameter

public SettableParameter[] getSettableParameter()

Description copied from interface: Component

Returns settable (i.e. editable while running) parameters. If none exist, null is returned.

Specified by:

getSettableParameter in interface Component

Returns:

array of settable parameters

getSettableParameter

public SettableParameter getSettableParameter(java.lang.String param)

Description copied from interface: Component

Return the settable parameter namede by this key-name. If this parameter is not found or is not settable, null is returned.

Specified by:

getSettableParameter in interface Component

Parameters:

param - key-name of the parameter

Returns:

named settable parameter

init

public void init(java.util.Properties map)

Parameters:

• name: name of this algorithm. Default is 'Graph Triples Histogram'
• actorType: mode to execute over. Default is 'tag'
• relation: realtion to execute over. Default is 'Tags'
• propertyNameSuffix: Suffix for the property name. Default is ' Directed Triples Histogram'

Specified by:

init in interface Component

Parameters:

map - parameters to be loaded - may be null