Tree

[DebuggerDisplay("Tree p:{Paths.Count} i:{LeafCount}")] public sealed class Tree : ITree
A non-generic data tree.

Properties

AllItems

#
public IEnumerable<object> AllItems { get; }
Enumerate over all items in this tree.
Implements: AllItems

AllPears

#
public IEnumerable<IPear> AllPears { get; }
Enumerate over all item/meta data pears in this tree.
Implements: AllPears

AllTwigs

#
public IEnumerable<ITwig> AllTwigs { get; }
Enumerate over all twigs in this tree.
Implements: AllTwigs

CommonMetaData

#
public MetaData CommonMetaData { get; }
Gets the non-conflicting meta data inside this tree.
Implements: CommonMetaData

Description

#
public string Description { get; }
Gets a string describing the topology of this tree.
Implements: Description

ItemCount

#
public int ItemCount { get; }
Gets the total number of non-null items in this tree.
Implements: ItemCount

Items

#
public IItemAccessor Items { get; }
Access the items in this tree.
Implements: Items

LeafCount

#
public int LeafCount { get; }
Gets the number of leaf items in this tree (this includes all items and all nulls).
Implements: LeafCount

MetaCount

#
public int MetaCount { get; }
Gets the number of meta data entries.
Implements: MetaCount

NonNullItems

#
public IEnumerable<object> NonNullItems { get; }
Enumerate over all non-null items in this tree.
Implements: NonNullItems

NonNullPears

#
public IEnumerable<IPear> NonNullPears { get; }
Enumerate over all non-null item/meta data pears in this tree.
Implements: NonNullPears

NullCount

#
public int NullCount { get; }
Gets the total number of null items in this tree.
Implements: NullCount

PathCount

#
public int PathCount { get; }
Gets the number of paths (and thus twigs) in this tree.
Implements: PathCount

Paths

#
public Paths Paths { get; }
Access the paths of this tree.
Implements: Paths

Pears

#
public IPearAccessor Pears { get; }
Access the pears in this tree.
Implements: Pears

Twigs

#
public ITwigAccessor Twigs { get; }
Access the twigs in this tree.
Implements: Twigs

Type

#
public Type Type { get; }
Gets the type of the data stored in this tree.
Implements: Type

TypeAssistant

#
public ITypeAssistant TypeAssistant { get; }
Gets the type assistant (if any) associated with the type constraint. More derived types that are stored in this tree may have more specific type assistants.
Implements: TypeAssistant

TypeFlavour

#
public TypeFlavour TypeFlavour { get; }
Gets some information about the generic type parameter of this tree.
Implements: TypeFlavour

Methods

ConvertItems<Q>

#
public Tree<Q> ConvertItems<Q>(Func<object, Q> replaceItem, Pear<Q> nullReplacement = null, CancellationToken token = default(CancellationToken))
Modify all items in this tree.
Parameters:
replaceItem (Func<object, Q>)Replacement method for non-null items.
nullReplacement (Pear<Q> = null)Replacement pear for null values. If not provided, nulls are simply persisted.
token (CancellationToken = null)Cancellation token.
Implements: ConvertItems

ConvertPears

#
public ITree ConvertPears(Func<IPear, IPear> replacePear, IPear nullReplacement = null, CancellationToken token = default(CancellationToken))
Modify all pears in this tree.
Parameters:
replacePear (Func<IPear, IPear>)Replacement method for non-null pears.
nullReplacement (IPear = null)Replacement method for nulls. If not provided, nulls are simply persisted.
token (CancellationToken = null)Cancellation token.
Implements: ConvertPears

ConvertPears<Q>

#
public Tree<Q> ConvertPears<Q>(Func<IPear, Pear<Q>> replacePear, Pear<Q> nullReplacement = null, CancellationToken token = default(CancellationToken))
Modify all pears in this tree.
Parameters:
replacePear (Func<IPear, Pear<Q>>)Replacement method for non-null items.
nullReplacement (Pear<Q> = null)Replacement method for nulls. If not provided, nulls are simply persisted.
token (CancellationToken = null)Cancellation token.
Implements: ConvertPears

Filter

#
public ITree Filter(IEnumerable<SiteRule> rules)
Apply a collection of rules to all the twigs and all the items in this tree.
Parameters:
rules (IEnumerable<SiteRule>)Rules to apply.
Returns: A new tree with only the twigs and items that were valid under the given rules.
Implements: Filter

Filter

#
public ITree Filter(params SiteRule[] rules)
Apply one or more rules to all the twigs and all the items in this tree.
Parameters:
rules (params SiteRule[])Rules to apply.
Returns: A new tree with only the twigs and items that were valid under the given rule.
Implements: Filter

Flatten

#
public ITree Flatten()
Flatten the entire tree.
Returns: Modified tree.
Implements: Flatten

Flatten

#
public ITree Flatten(Path path)
Flatten the entire tree.
Parameters:
path (Path)Path to flatten into.
Returns: Modified tree.
Implements: Flatten

Flip

#
public ITree Flip(int elementIndex, IndexModifier indexing)
Flip the tree by exchanging the twig indices of all items with one of the path elements.
Parameters:
elementIndex (int)Path element to flip.
indexing (IndexModifier)Indexing to apply to the indices.
Returns: Flipped tree.
Implements: Flip

GetCoverage

#
public object GetCoverage(Coverage coverage)
Gets the part of a tree that is implied by a specific coverage.
Parameters:
coverage (Coverage)Coverage.
Returns: Part of the tree identified by the coverage, or null if the coverage doesn't intersect with the tree.
Implements: GetCoverage

Graft

#
public ITree Graft()
Perform a graft operation on the entire tree.
Returns: Modified tree.
Implements: Graft

IsCoincidentWith

#
public bool IsCoincidentWith(Coverage coverage)
Test whether a given coverage coincides with this tree.
Parameters:
coverage (Coverage)Coverage to test.
Returns: True if the coverage is valid.
Implements: IsCoincidentWith

IsCoincidentWith

#
public bool IsCoincidentWith(Site site)
Tests whether a given site (path+twig index) is part of this tree.
Parameters:
site (Site)Tree site.
Returns: True if the site exists within the tree.
Implements: IsCoincidentWith

NullAt

#
public bool NullAt(int twigIndex, int itemIndex)
Gets whether a specific item is null or not.
Parameters:
twigIndex (int)Index of twig.
itemIndex (int)Index of item.
Returns: True if item at the given site is null.
Implements: NullAt

NullAt

#
public bool NullAt(Path path, int itemIndex)
Gets whether a specific item is null or not.
Parameters:
path (Path)Path of item twig.
itemIndex (int)Index within twig.
Returns: True if item at the given site is null.
Implements: NullAt

PathExists

#
public bool PathExists(Path path)
Parameters:
path (Path)

PathIndex

#
public int PathIndex(Path path)
Parameters:
path (Path)

ReplacePath

#
public ITree ReplacePath(Path find, Path replace)
Replace one path with another. If the replace path already exists within the tree, the items will be appended to the existing twig.
Parameters:
find (Path)Path to find.
replace (Path)Path to replace.
Returns: Modified tree.
Implements: ReplacePath

Similarity

#
public TreeSimilarity Similarity(ITree tree)
Compares two data trees for similarity.
Parameters:
tree (ITree)Data tree to compare to.
Returns: A TreeSimilarity type. This method never returns the PathsAndListsAndItems value.
Implements: Similarity

Split

#
public void Split(IEnumerable<SiteRule> rules, out ITree positive, out ITree negative)
Parameters:
rules (IEnumerable<SiteRule>)
positive (out ITree)
negative (out ITree)
Implements: Split

Split

#
public void Split(SiteRule rule, out ITree positive, out ITree negative)
Split this tree into a positive and a negative state by applying a specific rule.
Parameters:
rule (SiteRule)Rule to apply.
positive (out ITree)Tree containing all the twigs and items that are valid under the given rule.
negative (out ITree)Tree containing all the twigs and items that are invalid under the given rule.
Implements: Split

ToString

#
public override string ToString()
Returns a string that represents the current object.
Returns: A string that represents the current object.
Overrides: Object.ToString

ToString

#
public string ToString(TwigFormatStyle style)
Format this tree using a specific formatting template.
Parameters:
style (TwigFormatStyle)Formatting style.
Returns: String describing the tree.
Implements: ToString

TryConvert<TQ>

#
public Tree<TQ> TryConvert<TQ>()
Try and convert this tree into a tree of a specific type.
Returns: Tree of type TQ or null if no conversion could be found.
Implements: TryConvert

TryConvert<TQ>

#
public Tree<TQ> TryConvert<TQ>(CancellationToken token, ConversionRecord record)
Try and convert this tree into a tree of a specific type.
Parameters:
token (CancellationToken)Cancellation token.
record (ConversionRecord)If not null, conversion messages will be added to this record.
Returns: Tree of type TQ or null if no conversion could be found.
Implements: TryConvert

TryConvert<TQ>

#
public Tree<TQ> TryConvert<TQ>(CancellationToken token)
Try and convert this tree into a tree of a specific type.
Parameters:
token (CancellationToken)Cancellation token.
Returns: Tree of type TQ or null if no conversion could be found.
Implements: TryConvert

WithIncrementalPaths

#
public ITree WithIncrementalPaths()
Simplify the numbering of paths by starting at zero and incrementing by one for each element in the sequence.
Implements: WithIncrementalPaths

WithMetaData

#
public ITree WithMetaData(ITree source, MergeBehaviour mergeBehaviour)
Merge all data from another tree.
Parameters:
source (ITree)Source of meta data. Source.Count must equal the local ImageCount and any twig in source which contains meta data must have the same length as the corresponding twig in this tree.
mergeBehaviour (MergeBehaviour)Custom data merge behaviour.
Implements: WithMetaData

WithMetaData

#
public ITree WithMetaData(MetaData primary, MetaData secondary)
Assign meta data to all items in this tree.
Parameters:
primary (MetaData)Primary data (assign no matter what). May be null.
secondary (MetaData)Secondary data (assign only if doesn't conflict). May be null.
Returns: Potentially modified tree.
Implements: WithMetaData

WithoutEmptyTwigs

#
public ITree WithoutEmptyTwigs()
Remove all twigs that contain no items from this tree.
Returns: Modified tree.
Implements: WithoutEmptyTwigs

WithoutMetaData

#
public ITree WithoutMetaData()
Clear all meta data from all twigs, but leave items intact.
Implements: WithoutMetaData

WithoutNullItems

#
public ITree WithoutNullItems()
Remove all null items from all twigs.
Returns: Modified tree.
Implements: WithoutNullItems

WithoutPaths

#
public ITree WithoutPaths(IEnumerable<Path> paths)
Remove all specified paths and corresponding twigs.
Parameters:
paths (IEnumerable<Path>)Paths to remove.
Returns: Modified tree.
Implements: WithoutPaths

WithoutPaths

#
public ITree WithoutPaths(params Path[] paths)
Remove the specified paths and corresponding twigs from this tree.
Parameters:
paths (params Path[])Paths to remove.
Returns: Modified tree.
Implements: WithoutPaths

WithoutSites

#
public ITree WithoutSites(IEnumerable<Site> sites)
Remove all specified sites from the tree.
Parameters:
sites (IEnumerable<Site>)Sites to remove.
Returns: Modified tree
Implements: WithoutSites

WithoutSites

#
public ITree WithoutSites(params Site[] sites)
Remove the specified sites from this tree.
Parameters:
sites (params Site[])Loci to remove.
Returns: Modified tree.
Implements: WithoutSites

WithPathPrefix

#
public ITree WithPathPrefix(int element)
Prepend an integer to all paths in the tree.
Parameters:
element (int)Element to prepend.
Returns: Modified tree.
Implements: WithPathPrefix

WithPathPrefix

#
public ITree WithPathPrefix(Path path)
Prepend an entire path to all existing paths in the tree.
Parameters:
path (Path)Path to prepend.
Returns: Modified tree.
Implements: WithPathPrefix

WithPaths

#
public ITree WithPaths(Paths paths)
Create a new tree with different paths but the same twigs.
Parameters:
paths (Paths)
Returns: Modified tree.
Implements: WithPaths

WithPathSuffix

#
public ITree WithPathSuffix(int element)
Append an integer to all paths in the tree.
Parameters:
element (int)Element to append.
Returns: Modified tree.
Implements: WithPathSuffix

WithPathSuffix

#
public ITree WithPathSuffix(Path path)
Append an entire path to all existing paths in the tree.
Parameters:
path (Path)Path to append.
Returns: Modified tree.
Implements: WithPathSuffix

WithRandomisedTwigs

#
public ITree WithRandomisedTwigs()
Randomise the items within the twigs of this tree.
Implements: WithRandomisedTwigs

WithRandomisedTwigs

#
public ITree WithRandomisedTwigs(Random random)
Randomise the items within the twigs of this tree.
Parameters:
random (Random)
Implements: WithRandomisedTwigs

WithRenumberedPaths

#
public ITree WithRenumberedPaths()
Renumber all paths in this tree in ascending order.
Returns: Modified tree.
Implements: WithRenumberedPaths

WithRenumberedPaths

#
public ITree WithRenumberedPaths(int start)
Renumber all paths in this tree in ascending order.
Parameters:
start (int)Starting number for first path.
Returns: Modified tree.
Implements: WithRenumberedPaths

WithRenumberedPaths

#
public ITree WithRenumberedPaths(Path path, int index)
Renumber all paths in this tree in ascending order.
Parameters:
path (Path)Path layout to use for renumbering.
index (int)Element integer of path to increment.
Returns: Modified tree.
Implements: WithRenumberedPaths

WithReversedTwigs

#
public ITree WithReversedTwigs()
Reverse the order of all the items in the twigs of this tree.
Returns: Reversed tree.
Implements: WithReversedTwigs

WithSimplifiedPaths

#
public ITree WithSimplifiedPaths(PathAlignment options)
Perform a simplify operation on this tree.
Parameters:
options (PathAlignment)Simplify options
Returns: Modified tree.
Implements: WithSimplifiedPaths

WithSite

#
public ITree WithSite(Site site, IPear pear)
Parameters:
site (Site)
pear (IPear)
Implements: WithSite

WithSortedTwigs

#
public ITree WithSortedTwigs()
Sort all twigs using the default comparer.
Returns: Tree with sorted twigs.
Implements: WithSortedTwigs

WithTopology

#
public ITree WithTopology(ITree source)
Copy the topology of another tree while keeping the data from this tree. For a successful topology copy, the source and the target trees must have the same number of items.
Parameters:
source (ITree)Source tree to copy topology from.
Returns: modified tree.
Implements: WithTopology

WithTrimmedPaths

#
public ITree WithTrimmedPaths()
Trim the tree by removing the last element in each path and merging twigs together.
Returns: Modified tree.
Implements: WithTrimmedPaths

WithTrimmedPaths

#
public ITree WithTrimmedPaths(int count)
Trim the tree by removing the last N elements in each path and merging twigs together.
Parameters:
count (int)Number of elements to collapse.
Returns: Modified tree.
Implements: WithTrimmedPaths