Package pal.tree
Class SimpleNode
java.lang.Object
pal.tree.SimpleNode
- All Implemented Interfaces:
Serializable,AttributeNode,Node
- Direct Known Subclasses:
PositionedNode
data structure for a node (includes branch) in a binary/non-binary
rooted/unrooted tree
- Version:
- $Id: SimpleNode.java,v 1.27 2003/10/19 02:35:26 matt Exp $
- Author:
- Korbinian Strimmer, Alexei Drummond
- See Also:
-
Field Summary
Fields inherited from interface pal.tree.AttributeNode
CLADE_PROBABILITY, MEAN_CLADE_HEIGHT, NODE_HEIGHT_SE, SUBTREE_PROBABILITY -
Constructor Summary
ConstructorsModifierConstructorDescriptionconstructor default nodeSimpleNode(String name, double branchLength) SimpleNode(Node n) constructor used to clone a node and all childrenprotectedSimpleNode(Node[] children) protectedSimpleNode(Node[] children, double branchLength) ConstructorSimpleNode(Node n, boolean keepIds) SimpleNode(Node n, LabelMapping lm) -
Method Summary
Modifier and TypeMethodDescriptionvoidadd new child nodefinal ObjectgetAttribute(String name) final Enumerationfinal doubleGet the length of the branch attaching this node to its parent.final doubleGet the length SE of the branch attaching this node to its parent.getChild(int n) get child nodefinal intReturns the number of children this node has.final IdentifierReturns the identifier for this node.final doubleGet the height of this node relative to the most recent node.intreturn the index of this nodefinal NodeReturns the parent node of this node.byte[]Returns the sequence at this node, in the form of an array of bytes.Returns the sequence at this node, in the form of a String.booleancheck whether this node is an internal nodeprotected voidprotected voidInitialized node instance variables based on given Node.protected voidinit(Node n, boolean keepId, LabelMapping lm) Initialized node instance variables based on given Node.voidinsertChild(Node n, int pos) add new child node (insertion at a specific position)booleanisLeaf()check whether this node is an external nodebooleanisRoot()check whether this node is a root nodevoiddetermines the height of this node and its descendants from branch lengths, assuming contemporaneous tips.removeChild(int n) remove childfinal voidremoves parent.voidreset()final voidsetAttribute(String name, Object value) Sets a named attribute to the given value.final voidsetBranchLength(double value) Set the length of the branch attaching this node to its parent.final voidsetBranchLengthSE(double value) Set the length SE of the branch attaching this node to its parent.voidset child nodefinal voidSet identifier for this node.final voidsetNodeHeight(double value) Set the height of this node relative to the most recent node.final voidsetNodeHeight(double value, boolean adjustChildBranchLengths) Set the height of this node relative to the most recent node.voidsetNumber(int n) set the index of this nodevoidSet the parent node of this node.voidsetSequence(byte[] s) Sets the sequence at this node, in the form of an array of bytes.toString()
-
Constructor Details
-
SimpleNode
public SimpleNode()constructor default node -
SimpleNode
-
SimpleNode
Constructor- Parameters:
children-branchLength-- Throws:
IllegalArgumentException- if only one child!
-
SimpleNode
-
SimpleNode
constructor used to clone a node and all children -
SimpleNode
-
SimpleNode
-
-
Method Details
-
reset
public void reset() -
init
-
init
Initialized node instance variables based on given Node. children are ignored. -
init
Initialized node instance variables based on given Node. children are ignored.- Parameters:
lm- - may be null
-
getParent
Returns the parent node of this node. -
setParent
Set the parent node of this node. -
removeParent
public final void removeParent()removes parent. -
getSequenceString
Returns the sequence at this node, in the form of a String. -
getSequence
public byte[] getSequence()Returns the sequence at this node, in the form of an array of bytes.- Specified by:
getSequencein interfaceNode
-
setSequence
public void setSequence(byte[] s) Sets the sequence at this node, in the form of an array of bytes.- Specified by:
setSequencein interfaceNode
-
getBranchLength
public final double getBranchLength()Get the length of the branch attaching this node to its parent.- Specified by:
getBranchLengthin interfaceNode
-
setBranchLength
public final void setBranchLength(double value) Set the length of the branch attaching this node to its parent.- Specified by:
setBranchLengthin interfaceNode
-
getBranchLengthSE
public final double getBranchLengthSE()Get the length SE of the branch attaching this node to its parent.- Specified by:
getBranchLengthSEin interfaceNode
-
setBranchLengthSE
public final void setBranchLengthSE(double value) Set the length SE of the branch attaching this node to its parent.- Specified by:
setBranchLengthSEin interfaceNode
-
getNodeHeight
public final double getNodeHeight()Get the height of this node relative to the most recent node.- Specified by:
getNodeHeightin interfaceNode
-
setNodeHeight
public final void setNodeHeight(double value) Set the height of this node relative to the most recent node.- Specified by:
setNodeHeightin interfaceNode
-
setNodeHeight
public final void setNodeHeight(double value, boolean adjustChildBranchLengths) Set the height of this node relative to the most recent node.- Specified by:
setNodeHeightin interfaceNode- Parameters:
adjustChildBranchLengths- if true
-
getIdentifier
Returns the identifier for this node.- Specified by:
getIdentifierin interfaceNode
-
setIdentifier
Set identifier for this node.- Specified by:
setIdentifierin interfaceNode
-
setNumber
public void setNumber(int n) Description copied from interface:Nodeset the index of this node -
getNumber
public int getNumber()Description copied from interface:Nodereturn the index of this node -
getChild
get child node -
setChild
set child node -
hasChildren
public boolean hasChildren()check whether this node is an internal node- Returns:
- result (true or false)
-
isLeaf
public boolean isLeaf()check whether this node is an external node -
isRoot
public boolean isRoot()check whether this node is a root node -
addChild
add new child node -
insertChild
add new child node (insertion at a specific position)- Specified by:
insertChildin interfaceNode- Parameters:
n- new child node + @param pos position
-
removeChild
remove child- Specified by:
removeChildin interfaceNode- Parameters:
n- number of child to be removed
-
lengths2HeightsContemp
public void lengths2HeightsContemp()determines the height of this node and its descendants from branch lengths, assuming contemporaneous tips. -
setAttribute
Sets a named attribute to the given value.- Specified by:
setAttributein interfaceAttributeNode- Parameters:
name- the name of the attributevalue- the value to set the attribute
-
getAttribute
- Specified by:
getAttributein interfaceAttributeNode- Parameters:
name- the name of the attribute.- Returns:
- the attribute with the given name or null if it doesn't exist.
-
getAttributeNames
- Specified by:
getAttributeNamesin interfaceAttributeNode- Returns:
- an enumeration of the attributes that this node has or null if the node has no attributes.
-
getChildCount
public final int getChildCount()Returns the number of children this node has.- Specified by:
getChildCountin interfaceNode
-
toString
-