net.maizegenetics.taxa.tree

Interface Node

All Known Subinterfaces:

AttributeNode

All Known Implementing Classes:

SimpleNode

public Node

interface for a node (includes branch) in a binary/non-binary rooted/unrooted tree

Method Detail

getParent

Node getParent()

Returns the parent node of this node.

setParent

void setParent(Node node)

Set the parent node of this node.

getSequence

kotlin.Array[] getSequence()

Returns the sequence at this node, in the form an array of bytes.

setSequence

void setSequence(kotlin.Array[] array)

Sets the sequence using an array of bytes.

getNumber

int getNumber()

return the index of this node

setNumber

void setNumber(int number)

set the index of this node

getBranchLength

double getBranchLength()

Get the length of the branch attaching this node to its parent.

setBranchLength

void setBranchLength(double value)

Set the length of the branch attaching this node to its parent.

getBranchLengthSE

double getBranchLengthSE()

Get the length SE of the branch attaching this node to its parent.

setBranchLengthSE

void setBranchLengthSE(double value)

Set the length SE of the branch attaching this node to its parent.

getNodeHeight

double getNodeHeight()

Get the height of this node relative to the most recent node.

setNodeHeight

void setNodeHeight(double value)

Set the height of this node relative to the most recent node.

setNodeHeight

void setNodeHeight(double value,
                   boolean adjustChildBranchLengths)

Set the height of this node relative to the most recent node.

Parameters:

adjustChildBranchLengths - if true

getIdentifier

Taxon getIdentifier()

Returns the identifier for this node.

setIdentifier

void setIdentifier(Taxon id)

Set identifier for this node.

getChildCount

int getChildCount()

Returns the number of children this node has.

isLeaf

boolean isLeaf()

check whether this node is an external node

Returns:

org.jetbrains.dokka.NodeRenderContent@200cfd1b: result (true or false)

isRoot

boolean isRoot()

check whether this node is a root node

Returns:

org.jetbrains.dokka.NodeRenderContent@4f2b9ea4: result (true or false)

getChild

Node getChild(int n)

get child node

Parameters:

n - number of child

Returns:

org.jetbrains.dokka.NodeRenderContent@5b9beb3d: child node

setChild

void setChild(int n,
              Node node)

set child node

Parameters:

n - number

addChild

void addChild(Node c)

add new child node

Parameters:

c - new child node

insertChild

void insertChild(Node c,
                 int pos)

add new child node (insertion at a specific position)

Parameters:

c - new child node + @param pos position

removeChild

Node removeChild(int n)

remove child

Parameters:

n - number of child to be removed