Tree (deeplearning4j-nlp 0.0.3.2 API)

java.lang.Object
- org.deeplearning4j.models.rntn.Tree

All Implemented Interfaces:

Serializable
```
public class Tree
extends Object
implements Serializable
```
Tree for a recursive neural tensor network based on Socher et al's work.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Tree(List<String> tokens)

Tree(Tree tree)
Clone constructor (all but the children)

Tree(Tree parent, List<String> tokens)

Constructors
Constructor and Description
`Tree(List<String> tokens)`
`Tree(Tree tree)` Clone constructor (all but the children)
`Tree(Tree parent, List<String> tokens)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Tree`	`ancestor(int height, Tree root)` Returns the ancestor of the given tree
`List<Tree>`	`children()`
`Tree`	`clone()`
`void`	`connect(List<Tree> children)` Connects the given trees and sets the parents of the children
`int`	`depth()` Finds the depth of the tree.
`int`	`depth(Tree node)` Returns the distance between this node and the specified subnode
`boolean`	`equals(Object o)`
`double`	`error()` Returns the prediction error for this node
`double`	`errorSum()` Returns the total prediction error for this tree and its children
`Tree`	`firstChild()`
`int`	`getBegin()`
`List<Tree>`	`getChildren()`
`int`	`getEnd()`
`String`	`getHeadWord()`
`<T extends Tree> List<T>`	`getLeaves()` Gets the leaves of the tree.
`<T extends Tree> List<T>`	`getLeaves(List<T> list)` Gets the leaves of the tree.
`List<String>`	`getTokens()`
`String`	`getType()` The type of node; mainly extra meta data
`int`	`goldLabel()`
`int`	`hashCode()`
`boolean`	`isLeaf()` Returns whether the node has any children or not
`boolean`	`isPreTerminal()` Node has one child that is a leaf
`String`	`label()`
`Tree`	`lastChild()`
`Tree`	`parent()`
`Tree`	`parent(Tree root)` Returns the parent of the passed in tree via traversal
`org.nd4j.linalg.api.ndarray.INDArray`	`prediction()`
`void`	`setBegin(int begin)`
`void`	`setEnd(int end)`
`void`	`setError(double error)`
`void`	`setGoldLabel(int goldLabel)`
`void`	`setHeadWord(String headWord)`
`void`	`setLabel(String label)`
`void`	`setParent(Tree parent)`
`void`	`setParse(String parse)`
`void`	`setPrediction(org.nd4j.linalg.api.ndarray.INDArray prediction)`
`void`	`setTags(List<String> tags)`
`void`	`setTokens(List<String> tokens)`
`void`	`setType(String type)`
`void`	`setValue(String value)`
`void`	`setVector(org.nd4j.linalg.api.ndarray.INDArray vector)`
`List<String>`	`tags()`
`String`	`toString()`
`String`	`value()`
`org.nd4j.linalg.api.ndarray.INDArray`	`vector()`
`List<String>`	`yield()` Returns all of the labels for this node and all of its children (recursively)

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Tree
```
public Tree(Tree tree)
```
    Clone constructor (all but the children)
    
    Parameters:
    
    tree - the tree to clone
  - Tree
```
public Tree(Tree parent,
            List<String> tokens)
```
  - Tree
```
public Tree(List<String> tokens)
```
- Method Detail
  - getType
```
public String getType()
```
    The type of node; mainly extra meta data
    
    Returns:
  - setType
```
public void setType(String type)
```
  - yield
```
public List<String> yield()
```
    Returns all of the labels for this node and all of its children (recursively)
    
    Returns:
    
    all of the labels of this node and its children recursively
  - setGoldLabel
```
public void setGoldLabel(int goldLabel)
```
  - goldLabel
```
public int goldLabel()
```
  - setLabel
```
public void setLabel(String label)
```
  - label
```
public String label()
```
  - value
```
public String value()
```
  - setValue
```
public void setValue(String value)
```
  - isLeaf
```
public boolean isLeaf()
```
    Returns whether the node has any children or not
    
    Returns:
    
    whether the node has any children or not
  - children
```
public List<Tree> children()
```
  - isPreTerminal
```
public boolean isPreTerminal()
```
    Node has one child that is a leaf
    
    Returns:
    
    whether the node has one child and the child is a leaf
  - firstChild
```
public Tree firstChild()
```
  - lastChild
```
public Tree lastChild()
```
  - depth
```
public int depth()
```
    Finds the depth of the tree. The depth is defined as the length of the longest path from this node to a leaf node. Leaf nodes have depth zero. POS tags have depth 1. Phrasal nodes have depth >= 2.
    
    Returns:
    
    the depth
  - depth
```
public int depth(Tree node)
```
    Returns the distance between this node and the specified subnode
    
    Parameters:
    
    node - the node to getFromOrigin the distance from
    
    Returns:
    
    the distance between the 2 nodes
  - parent
```
public Tree parent(Tree root)
```
    Returns the parent of the passed in tree via traversal
    
    Parameters:
    
    root - the root node
    
    Returns:
    
    the tree to traverse
  - ancestor
```
public Tree ancestor(int height,
                     Tree root)
```
    Returns the ancestor of the given tree
    
    Parameters:
    
    height -
    
    root -
    
    Returns:
  - errorSum
```
public double errorSum()
```
    Returns the total prediction error for this tree and its children
    
    Returns:
    
    the total error for this tree and its children
  - getLeaves
```
public <T extends Tree> List<T> getLeaves()
```
    Gets the leaves of the tree. All leaves nodes are returned as a list ordered by the natural left to right order of the tree. Null values, if any, are inserted into the list like any other value.
    
    Returns:
    
    a List of the leaves.
  - getLeaves
```
public <T extends Tree> List<T> getLeaves(List<T> list)
```
    Gets the leaves of the tree.
    
    Parameters:
    
    list - The list in which the leaves of the tree will be placed. Normally, this will be empty when the routine is called, but if not, the new yield is added to the end of the list.
    
    Returns:
    
    a List of the leaves.
  - clone
```
public Tree clone()
```
    Overrides:
    
    clone in class Object
  - error
```
public double error()
```
    Returns the prediction error for this node
    
    Returns:
    
    the prediction error for this node
  - setError
```
public void setError(double error)
```
  - getTokens
```
public List<String> getTokens()
```
  - setTokens
```
public void setTokens(List<String> tokens)
```
  - setParent
```
public void setParent(Tree parent)
```
  - parent
```
public Tree parent()
```
  - vector
```
public org.nd4j.linalg.api.ndarray.INDArray vector()
```
  - setVector
```
public void setVector(org.nd4j.linalg.api.ndarray.INDArray vector)
```
  - prediction
```
public org.nd4j.linalg.api.ndarray.INDArray prediction()
```
  - setPrediction
```
public void setPrediction(org.nd4j.linalg.api.ndarray.INDArray prediction)
```
  - tags
```
public List<String> tags()
```
  - setTags
```
public void setTags(List<String> tags)
```
  - getChildren
```
public List<Tree> getChildren()
```
  - getHeadWord
```
public String getHeadWord()
```
  - setHeadWord
```
public void setHeadWord(String headWord)
```
  - setParse
```
public void setParse(String parse)
```
  - connect
```
public void connect(List<Tree> children)
```
    Connects the given trees and sets the parents of the children
    
    Parameters:
    
    children - the children to connect with
  - getBegin
```
public int getBegin()
```
  - setBegin
```
public void setBegin(int begin)
```
  - getEnd
```
public int getEnd()
```
  - setEnd
```
public void setEnd(int end)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class Tree

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Tree

Tree

Tree

Method Detail

getType

setType

yield

setGoldLabel

goldLabel

setLabel

label

value

setValue

isLeaf

children

isPreTerminal

firstChild

lastChild

depth

depth

parent

ancestor

errorSum

getLeaves

getLeaves

clone

error

setError

getTokens

setTokens

setParent

parent

vector

setVector

prediction

setPrediction

tags

setTags

getChildren

getHeadWord

setHeadWord

setParse

connect

getBegin

setBegin

getEnd

setEnd

toString

equals

hashCode