Package convex.core.data

Class Refs

java.lang.Object

convex.core.data.Refs

public class Refs
extends Object

Static utilities for working with Refs

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Refs.RefTreeStats

Constructor Summary

Constructors

Constructor	Description
Refs()

Method Summary

Modifier and Type	Method	Description
static Set<Ref<?>>	accumulateRefSet(ACell a)	Accumulates the set of all unique Refs in the given object.
static Set<Ref<?>>	accumulateRefSet(Ref<?> root)
static void	checkConsistentStores(Ref<?> root, AStore store)	Checks the complete tree of Refs is consistent with the given store
static Refs.RefTreeStats	getRefTreeStats(Ref<?> root)	Gets statistics for a tree of Refs
static String	printMissingTree(ACell value)
static void	printMissingTree(StringBuilder sb, ACell value)	Utility function to locate missing data
static long	totalRefCount(ACell a)	Counts the total number of Refs contained in a data object recursively, including the given cell.
static long	uniqueRefCount(ACell a)	Counts the number of logically unique Refs for a Cell, i.e.
static void	visitAllRefs(Ref<?> root, Consumer<Ref<?>> visitor)	Visit all Refs in a tree of Refs, in depth first order.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Refs

public Refs()

Method Details

visitAllRefs

public static void visitAllRefs(Ref<?> root,
 Consumer<Ref<?>> visitor)

Visit all Refs in a tree of Refs, in depth first order. Requires O(1) stack, O(n) time and O(depth) memory.

Parameters:

root - Root of Ref tree to visit

visitor - Visitor function to call for each Ref

checkConsistentStores

public static void checkConsistentStores(Ref<?> root,
 AStore store)

Checks the complete tree of Refs is consistent with the given store

Parameters:

root - Root of Ref tree to visit

store - Store to check consistency with

getRefTreeStats

public static Refs.RefTreeStats getRefTreeStats(Ref<?> root)

Gets statistics for a tree of Refs

Parameters:

root - Root node of Ref Tree

Returns:

Stats object

accumulateRefSet

public static Set<Ref<?>> accumulateRefSet(ACell a)

Accumulates the set of all unique Refs in the given object.

Parameters:

a - Ref or Cell

Returns:

Set containing all unique refs (accumulated recursively) within the given object

accumulateRefSet

public static Set<Ref<?>> accumulateRefSet(Ref<?> root)

totalRefCount

public static long totalRefCount(ACell a)

Counts the total number of Refs contained in a data object recursively, including the given cell. Will count duplicate children multiple times.

Parameters:

a - Object to count Refs in

Returns:

Total number of Refs found

uniqueRefCount

public static long uniqueRefCount(ACell a)

Counts the number of logically unique Refs for a Cell, i.e. the number of unique cell values (including this Cell)

Parameters:

a - Cell to count Refs in

Returns:

Number of Refs found

printMissingTree

public static void printMissingTree(StringBuilder sb,
 ACell value)

Utility function to locate missing data

Parameters:

sb - StringBuilder to append to

value - Value to search for missing data

printMissingTree

public static String printMissingTree(ACell value)