Hyperbolic Tree

Sets of classes and objects to plot and calculate a hyperbolic tree.

Summary

Hyperbolic Tree	Sets of classes and objects to plot and calculate a hyperbolic tree.
Canvas	A multi-purpose Canvas object decorator.
Functions
Canvas	Canvas initializer.
getContext	Canvas context handler.
setPosition	Calculates canvas absolute position on HTML document.
getPosition	Canvas absolute position to the HTML document.
clear	Clears the canvas object.
drawMainCircle	Draws the boundary circle for the Hyperbolic Tree.
translateToCenter	Translates canvas coordinates system to the center of the canvas object.
getSize	An object that contains the canvas width and height.
Mouse	A multi-purpose Mouse class.
Functions
getPosition	Returns mouse position relative to canvas.
capturePosition	Captures mouse position.
HyperLine	The HyperLine class allows you to draw “lines” on the Poincare’s disk model for Hyperbolic Geometry.
Functions
HyperLine	HyperLine constructor.
printOn	Draws the HyperLine on canvas.
correctAngle	For private use only: corrects angle value based on quadrant.
sense	For private use only: sets angle direction to clockwise (true) or counterclockwise (false).
arcThroughTwoPoints	For private use only.
Complex	A multi-purpose Complex Class with common methods.
Functions
Complex	Complex constructor.
norm	Calculates the complex norm.
squaredNorm	Calculates the complex squared norm.
add	Returns the result of adding two complex numbers.
prod	Returns the result of multiplying two complex numbers.
moebiusTransformation	Calculates a moebius transformation for this point / complex.
conjugate	Returns the conjugate por this complex.
scale	Returns the result of scaling a Complex instance.
toString	Returns a string that shows the Complex properties.
Node	Behaviour of the hyperbolic tree node.
Functions
Node	Node constructor.
Properties
id
drawn	Node flag
initLength	node distance to center
angle span	allowed angle span for adjacencies placement
pos	node position
info	additional node information
adjacencies	node adjacencies
Functions
adjacentTo	Indicates if the node is adjacent to the node indicated by the specified id
addAdjacency	Connects the node to the specified by id.
printInfoAsRootOn	Creates a label containing the root node information.
printInfoOn	Creates a label containing the node information.
printOn	Plots the node on canvas.
setDivProperties	Intended for private use: sets some label properties, such as positioning and className.
norm	Calculates node’s distance to origin.
Config	Hyperbolic Tree configuration object.
Properties
labelContainer	id for label container
drawMainCircle	show/hide main circle
showNodes	show/hide nodes
showEdges	show/hide edges
showLabels	show/hide labels, must be set to false if the nodes have no additional info.
initLength	initial edge length
angleRate	angle span rate
timeSlot	time slot for animation frame
animationTime
depth	for non-JSON generated trees: tree depth
children	for non-JSON generated trees: number of children
prob	for non-JSON generated trees: probability of edge creation
loadTreeArray	for non-JSON generated trees: customizeable array of nodes per depth level
HT	Hyperbolic Tree (HT) class.
Functions
HT	Creates a new HT instance.
addAdjacence	Connects nodes specified by id1 and id2.
addNode	Adds a node.
hasNode	Returns a Boolean instance indicating if node belongs to graph or not.
initialize	Loads parameters and places the HT.
moebiusTransformation	Calculates a moebius transformation for the hyperbolic tree.
calculatePositions	Intended for private use: calculates node positions on canvas by performing a BFS-like algorithm
calculateChildrenPositions	Intended for private use: calculates positions for children and grandchildren of root node.
printEdges	Prints graph / tree edges
translateTo	Tranlates the HT to a given position
setFlag	For private use: sets a flag.
printNodesAt	Used for drawing the HT on a frame
printOn	Prints the HT on canvas
printNodesRelativeAt	Prints the HT nodes after being translated to a relative position.
makeLabelsForCenteredNode	Creates and displays labels for the centered node and its adjacent nodes.
translate	Translates the HT to the mouse position.
loadTree	Loads an HT with the depth, children and prob parameters stored in the Config object.
loadTreeByArray	Loads an HT with the loadTreeArray parameter stored in the Config object.
loadTreeByJSON
getNodeInfoById	Returns a node info property.
getNodeInfoById	To be set by user: execute this function when performing an event to the label.
Objects	In this section you’ll find the objects that you must use in order to make a Canvas or HyperbolicTree instance.
Variables
canvas	Use this object to store a new Canvas instance.
ht	Use this object to store a new HT instance.

Canvas

A multi-purpose Canvas object decorator.

Summary

Functions
Canvas	Canvas initializer.
getContext	Canvas context handler.
setPosition	Calculates canvas absolute position on HTML document.
getPosition	Canvas absolute position to the HTML document.
clear	Clears the canvas object.
drawMainCircle	Draws the boundary circle for the Hyperbolic Tree.
translateToCenter	Translates canvas coordinates system to the center of the canvas object.
getSize	An object that contains the canvas width and height.

HyperLine

The HyperLine class allows you to draw “lines” on the Poincare’s disk model for Hyperbolic Geometry. You just have to specify two Complex numbers that will be used for drawing the line.

Summary

Functions
HyperLine	HyperLine constructor.
printOn	Draws the HyperLine on canvas.
correctAngle	For private use only: corrects angle value based on quadrant.
sense	For private use only: sets angle direction to clockwise (true) or counterclockwise (false).
arcThroughTwoPoints	For private use only.

Complex

A multi-purpose Complex Class with common methods.

Summary

Functions
Complex	Complex constructor.
norm	Calculates the complex norm.
squaredNorm	Calculates the complex squared norm.
add	Returns the result of adding two complex numbers.
prod	Returns the result of multiplying two complex numbers.
moebiusTransformation	Calculates a moebius transformation for this point / complex.
conjugate	Returns the conjugate por this complex.
scale	Returns the result of scaling a Complex instance.
toString	Returns a string that shows the Complex properties.

Node

Behaviour of the hyperbolic tree node.

Summary

Functions
Node	Node constructor.
Properties
id
drawn	Node flag
initLength	node distance to center
angle span	allowed angle span for adjacencies placement
pos	node position
info	additional node information
adjacencies	node adjacencies
Functions
adjacentTo	Indicates if the node is adjacent to the node indicated by the specified id
addAdjacency	Connects the node to the specified by id.
printInfoAsRootOn	Creates a label containing the root node information.
printInfoOn	Creates a label containing the node information.
printOn	Plots the node on canvas.
setDivProperties	Intended for private use: sets some label properties, such as positioning and className.
norm	Calculates node’s distance to origin.

Config

Hyperbolic Tree configuration object. This object must be passed when calling a new hyperbolic tree instance:

var ht= new HT(Config, canvas);

The top 9 parameters (animationTime included) are necessary to execute the HT algorithm properly.

Summary

Properties
labelContainer	id for label container
drawMainCircle	show/hide main circle
showNodes	show/hide nodes
showEdges	show/hide edges
showLabels	show/hide labels, must be set to false if the nodes have no additional info.
initLength	initial edge length
angleRate	angle span rate
timeSlot	time slot for animation frame
animationTime
depth	for non-JSON generated trees: tree depth
children	for non-JSON generated trees: number of children
prob	for non-JSON generated trees: probability of edge creation
loadTreeArray	for non-JSON generated trees: customizeable array of nodes per depth level

HT

Hyperbolic Tree (HT) class. There are three ways of generating a HT object. You can use depth, children and prob properties of the Config object to define a HT. You can also use the loadTreeArray property of the Config object to define each level of the tree. Finally, you can load a HT with a JSON array.

Summary

Functions
HT	Creates a new HT instance.
addAdjacence	Connects nodes specified by id1 and id2.
addNode	Adds a node.
hasNode	Returns a Boolean instance indicating if node belongs to graph or not.
initialize	Loads parameters and places the HT.
moebiusTransformation	Calculates a moebius transformation for the hyperbolic tree.
calculatePositions	Intended for private use: calculates node positions on canvas by performing a BFS-like algorithm
calculateChildrenPositions	Intended for private use: calculates positions for children and grandchildren of root node.
printEdges	Prints graph / tree edges
translateTo	Tranlates the HT to a given position
setFlag	For private use: sets a flag.
printNodesAt	Used for drawing the HT on a frame
printOn	Prints the HT on canvas
printNodesRelativeAt	Prints the HT nodes after being translated to a relative position.
makeLabelsForCenteredNode	Creates and displays labels for the centered node and its adjacent nodes.
translate	Translates the HT to the mouse position.
loadTree	Loads an HT with the depth, children and prob parameters stored in the Config object.
loadTreeByArray	Loads an HT with the loadTreeArray parameter stored in the Config object.
loadTreeByJSON
getNodeInfoById	Returns a node info property.
getNodeInfoById	To be set by user: execute this function when performing an event to the label.

Objects

In this section you’ll find the objects that you must use in order to make a Canvas or HyperbolicTree instance. There’s three ways of doing this:

Loading a HT with specified depth (Config.depth), children (Config.children) and probability of edge creation Config.prob. Each level will be completed with the same amount of nodes. Take for example:

canvas= new Canvas('hypertree', 'white', 'white');
 canvas.setPosition();
 canvas.translateToCenter();
 //use a cross-browser event handler function
 addEvent(canvas.canvas, 'click', function (e) { Mouse.capturePosition(e); ht.translate(Mouse); });

 ht= new HT(Config, canvas);
 ht.loadTree();

Loading a HT from a specified array (Config.loadTreeArray)

canvas= new Canvas('hypertree', 'white', 'white');
canvas.setPosition();
canvas.translateToCenter();
addEvent(canvas.canvas, 'click', function (e) { Mouse.capturePosition(e); ht.translate(Mouse); });

ht= new HT(Config, canvas);
ht.loadTreeByArray();

Loading a HT from a JSON array that displays some extra-information. In order to do this you must set a handler function(<HT.labelHandler>) that will be called onclick.

function    labelHandler(ide) {
        var content= ht.getNodeInfoById(ide).replace(/ /g, '+');
    //This function could make an AJAX call to
    //grab some JSON information somewhere
    loadFromJSON(content);
}


//when document loads...
function initOnLoad(content) {
  canvas= new Canvas('hypertree', 'white', 'white');
  canvas.setPosition();
  canvas.translateToCenter();
  addEvent(canvas.canvas, 'click', function (e) { Mouse.capturePosition(e); ht.translate(Mouse); });

  ht= new HT(Config, canvas);
  ht.labelOnEventHandler= labelHandler;


  loadFromJSON(content);

}

Summary

Variables
canvas	Use this object to store a new Canvas instance.
ht	Use this object to store a new HT instance.

Hyperbolic Tree

Canvas

Functions

Canvas

Parameters

Returns

getContext

Returns

setPosition

getPosition

Returns

clear

drawMainCircle

translateToCenter

getSize

Returns

Mouse

Functions

getPosition

Parameters

Returns

capturePosition

Parameters

HyperLine

Functions

HyperLine

Parameters

Returns

printOn

Parameters

correctAngle

Parameters

Returns

sense

Parameters

Returns

arcThroughTwoPoints

Returns

Complex

Functions

Complex

Parameters

Returns

norm

Returns

squaredNorm

Returns

add

Parameters

Returns

prod

Parameters

Returns

moebiusTransformation

Parameters

conjugate

Returns

scale

Parameters

Returns

toString

Returns

Node

Functions

Node

Parameters

Returns

Properties

id

drawn

initLength

angle span

pos

info

adjacencies

Functions

adjacentTo

Parameters

Returns

addAdjacency