SpTree (deeplearning4j 1.0.0-beta6 API)

java.lang.Object
- org.deeplearning4j.clustering.sptree.SpTree

All Implemented Interfaces:

Serializable
```
public class SpTree
extends Object
implements Serializable
```
Author:

Adam Gibson

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static int NODE_RATIO

static String workspaceExternal

Fields
Modifier and Type	Field and Description
`static int`	`NODE_RATIO`
`static String`	`workspaceExternal`

Constructor Summary

Constructors
Constructor and Description
`SpTree(INDArray data)`
`SpTree(INDArray data, Collection<INDArray> indices)`
`SpTree(INDArray data, Collection<INDArray> indices, String similarityFunction)`
`SpTree(SpTree parent, INDArray data, INDArray corner, INDArray width, Collection<INDArray> indices)`
`SpTree(SpTree parent, INDArray data, INDArray corner, INDArray width, Collection<INDArray> indices, String similarityFunction)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`computeEdgeForces(INDArray rowP, INDArray colP, INDArray valP, int N, INDArray posF)` Compute edge forces using barnes hut
`void`	`computeNonEdgeForces(int pointIndex, double theta, INDArray negativeForce, org.nd4j.shade.guava.util.concurrent.AtomicDouble sumQ)` Compute non edge forces using barnes hut
`int`	`depth()` The depth of the node
`Cell`	`getBoundary()`
`INDArray`	`getCenterOfMass()`
`SpTree[]`	`getChildren()`
`int`	`getCumSize()`
`int`	`getD()`
`int[]`	`getIndex()`
`int`	`getNumChildren()`
`boolean`	`isCorrect()` Verifies the structure of the tree (does bounds checking on each node)
`boolean`	`isLeaf()`
`void`	`setCumSize(int cumSize)`
`void`	`setNumChildren(int numChildren)`
`void`	`subDivide()` Subdivide the node in to 4 children
`MemoryWorkspace`	`workspace()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- workspaceExternal
```
public static final String workspaceExternal
```
  See Also:
  
  Constant Field Values
- NODE_RATIO
```
public static final int NODE_RATIO
```
  See Also:
  
  Constant Field Values

Constructor Detail

SpTree

public SpTree(SpTree parent,
              INDArray data,
              INDArray corner,
              INDArray width,
              Collection<INDArray> indices,
              String similarityFunction)

SpTree

public SpTree(INDArray data,
              Collection<INDArray> indices,
              String similarityFunction)

SpTree

public SpTree(SpTree parent,
              INDArray data,
              INDArray corner,
              INDArray width,
              Collection<INDArray> indices)

SpTree

public SpTree(INDArray data,
              Collection<INDArray> indices)

SpTree
```
public SpTree(INDArray data)
```

Method Detail

workspace
```
public MemoryWorkspace workspace()
```

subDivide
```
public void subDivide()
```
Subdivide the node in to 4 children

computeNonEdgeForces

public void computeNonEdgeForces(int pointIndex,
                                 double theta,
                                 INDArray negativeForce,
                                 org.nd4j.shade.guava.util.concurrent.AtomicDouble sumQ)

Compute non edge forces using barnes hut

Parameters:: pointIndex -; theta -; negativeForce -; sumQ -

computeEdgeForces

public void computeEdgeForces(INDArray rowP,
                              INDArray colP,
                              INDArray valP,
                              int N,
                              INDArray posF)

Compute edge forces using barnes hut

Parameters:: rowP - a vector; colP -; valP -; N - the number of elements; posF - the positive force

isLeaf
```
public boolean isLeaf()
```

isCorrect
```
public boolean isCorrect()
```
Verifies the structure of the tree (does bounds checking on each node)

Returns:

true if the structure of the tree is correct.

depth
```
public int depth()
```
The depth of the node

Returns:

the depth of the node

getChildren
```
public SpTree[] getChildren()
```

getD
```
public int getD()
```

getCenterOfMass
```
public INDArray getCenterOfMass()
```

getBoundary
```
public Cell getBoundary()
```

getIndex
```
public int[] getIndex()
```

getCumSize
```
public int getCumSize()
```

setCumSize
```
public void setCumSize(int cumSize)
```

getNumChildren
```
public int getNumChildren()
```

setNumChildren

public void setNumChildren(int numChildren)

Class SpTree

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

workspaceExternal

NODE_RATIO

Constructor Detail

SpTree

SpTree

SpTree

SpTree

SpTree

Method Detail

workspace

subDivide

computeNonEdgeForces

computeEdgeForces

isLeaf

isCorrect

depth

getChildren

getD

getCenterOfMass

getBoundary

getIndex

getCumSize

setCumSize

getNumChildren

setNumChildren