TreeList

public struct TreeList<Value>

extension TreeList: ExpressibleByArrayLiteral

extension TreeList: MutableCollection, BidirectionalCollection

extension TreeList: Equatable where Value: Equatable

extension TreeList: Hashable where Value: Hashable

extension TreeList: CustomStringConvertible where Value: CustomStringConvertible

Undocumented

nodes
Undocumented
Declaration
Swift

public var nodes: [TreeNode<Value>]
init(_:)
Undocumented
Declaration
Swift

public init(_ nodes: [TreeNode<Value>])


                    
                    
                    init(arrayLiteral:)

Declaration

Swift

public init(arrayLiteral elements: TreeNode<Value>...)


                    
                    
                    Element

Declaration

Swift

public typealias Element = TreeNode<Value>

Index
Declaration
Swift

public typealias Index = TreeIndex


                    
                    
                    startIndex

Declaration

Swift

public var startIndex: TreeIndex { get }

endIndex
Declaration
Swift

public var endIndex: TreeIndex { get }
count
Declaration
Swift

public var count: Int { get }


                    
                    
                    underestimatedCount

Declaration

Swift

public var underestimatedCount: Int { get }


                    
                    
                    subscript(_:)

Declaration

Swift

public subscript(position: TreeIndex) -> Element { get set }


                    
                    
                    index(after:)

Declaration

Swift

public func index(after i: TreeIndex) -> TreeIndex


                    
                    
                    index(before:)

Declaration

Swift

public func index(before i: TreeIndex) -> TreeIndex

init()
Undocumented
Declaration
Swift

public init()


                    
                    
                    remove(at:)

Undocumented

Declaration

Swift

public mutating func remove<S>(at indices: S) where S : Sequence, S.Element == TreeIndex


                    
                    
                    removeSubrange(_:)

Undocumented

Declaration

Swift

public mutating func removeSubrange(_ bounds: Range<TreeIndex>)


                    
                    
                    remove(at:)

Undocumented

Declaration

Swift

@discardableResult
public mutating func remove(at i: TreeIndex) -> Element


                    
                    
                    insert(contentsOf:at:)

Undocumented

Declaration

Swift

public mutating func insert<S>(contentsOf newElements: S, at i: TreeIndex) where S : Collection, S.Element == TreeList<Value>.Element


                    
                    
                    insert(_:at:)

Undocumented

Declaration

Swift

public mutating func insert(_ element: TreeNode<Value>, at index: TreeIndex)


                    
                    
                    depth(of:)

Undocumented

Declaration

Swift

public func depth(of i: TreeIndex) -> Int


                    
                    
                    parentIndex(of:)

Undocumented

Declaration

Swift

public func parentIndex(of i: TreeIndex) -> TreeIndex


                    
                    
                    childIndex(of:)

Undocumented

Declaration

Swift

public func childIndex(of i: TreeIndex) -> Int


                    
                    
                    addChildIndex(_:to:)

Undocumented

Declaration

Swift

public func addChildIndex(_ i: Int, to baseIndex: TreeIndex) -> TreeIndex


                    
                    
                    neighbours(at:)

Undocumented

Declaration

Swift

public func neighbours(at i: TreeIndex) -> [TreeNode<Value>]


                    
                    
                    canInsert(at:)

Undocumented

Declaration

Swift

public func canInsert(at i: TreeIndex) -> Bool


                    
                    
                    mapValues(_:)

Undocumented

Declaration

Swift

public func mapValues<NewValue>(_ transform: (Value) -> NewValue) -> TreeList<NewValue>


                    
                    
                    mapValuesWithNode(_:)

Undocumented

Declaration

Swift

public func mapValuesWithNode<NewValue>(_ transform: (TreeNode<Value>) -> NewValue) -> TreeList<NewValue>


                    
                    
                    mapValuesWithParents(_:)

Undocumented

Declaration

Swift

public func mapValuesWithParents<NewValue>(_ transform: ([Value], Value) -> NewValue) -> TreeList<NewValue>


                    
                    
                    mapChildrenWithParent(_:)

Undocumented

Declaration

Swift

public func mapChildrenWithParent<NewValue>(_ transform: (Value?, [Value]) -> NewValue) -> [NewValue]


                    
                    
                    mapChildrenWithParents(_:)

Undocumented

Declaration

Swift

public func mapChildrenWithParents<NewValue>(
    _ transform: (_ parents: [Value], _ children: [Value]) -> NewValue
) -> [NewValue]

compactMap


                    
                    
                    compactMapValues(_:)

Undocumented

Declaration

Swift

public func compactMapValues<NewValue>(_ transform: (Value) -> NewValue?) -> TreeList<NewValue>

filter


                    
                    
                    filterValues(_:)

Undocumented

Declaration

Swift

public func filterValues(_ isIncluded: (Value) -> Bool) -> TreeList<Value>

Move


                    
                    
                    removeAll(where:)

Undocumented

Declaration

Swift

public mutating func removeAll(where shouldBeRemoved: (TreeNode<Value>) -> Bool)

Available where `Value`: `CustomStringConvertible`

description
Declaration
Swift

public var description: String { get }

Available where `Value`: `Hashable`


                    
                    
                    move(indices:to:)

Moves the TreeNodes at the given sourceIndices to insertIndex. The sourceIndices and insertIndex are both specified in the before state of the tree. If elements are removed before the insertIndex, the insertIndex will be adjusted.

The move operation will fail and return nil, if the insertIndex is a child of one of the moved TreeNodes.

Declaration

Swift

public func move(indices sourceIndices: [TreeIndex], to insertIndex: TreeIndex) -> TreeList<Value>?

Parameters

`sourceIndices`	the indices of the elements that should be moved
`insertIndex`	the insertion index to move the elements to

Return Value

A new Tree with the specified changes or nil if the the move was not possible


                    
                    
                    difference(from:)

Undocumented

Declaration

Swift

public func difference(from old: `Self`) -> TreeDifference<Value>


                    
                    
                    applying(_:)

Undocumented

Declaration

Swift

public func applying(_ diff: TreeDifference<Value>) -> `Self`?

TreeList

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

compactMap

Declaration

filter

Declaration

Move

Declaration

Available where Value: CustomStringConvertible

Declaration

Available where Value: Hashable

Declaration

Parameters

Return Value

Declaration

Declaration

Available where `Value`: `CustomStringConvertible`

Available where `Value`: `Hashable`