Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/openalloc/swiftsimpletree
A nested data structure that’s flexible and easy to use
https://github.com/openalloc/swiftsimpletree
data-structure hierarchical-data nested-structures swift-generics swift-lang swift-language swift-library tree tree-structure
Last synced: about 1 month ago
JSON representation
A nested data structure that’s flexible and easy to use
- Host: GitHub
- URL: https://github.com/openalloc/swiftsimpletree
- Owner: openalloc
- License: apache-2.0
- Created: 2021-11-18T07:15:23.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-01T23:59:25.000Z (over 1 year ago)
- Last Synced: 2024-03-14T23:47:12.731Z (8 months ago)
- Topics: data-structure, hierarchical-data, nested-structures, swift-generics, swift-lang, swift-language, swift-library, tree, tree-structure
- Language: Swift
- Homepage:
- Size: 25.4 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# SwiftSimpleTree
A nested data structure that’s flexible and easy to use.
Available as an open source Swift library to be incorporated in other apps.
_SwiftSimpleTree_ is part of the [OpenAlloc](https://github.com/openalloc) family of open source Swift software tools.
## SimpleTree
```swift
let foo = SimpleTree(value: "foo")
let bar = foo.addChild(value: "bar")
let baz = bar.addChild(value: "baz")
print(foo.getFirst(for: "baz")?.value)
=> "baz"
print(baz.getParentValues())
=> ["bar", "foo"]
print(foo.getChildValues())
=> ["bar", "baz"]
print(foo.getSelfAndChildValues())
=> ["foo", "bar", "baz"]
```
## Types
Types scoped within `SimpleTree`:
- `typealias Node = SimpleTree` - a tree node, where `T` is your hashable type.
- `typealias ValueSet = Set` - a set of values, where `T` is your hashable type.
An enumeration is used for the `traversal` argument in the `getChildren()` methods:
```swift
public enum Traversal {
case depthFirst
case breadthFirst
}
```
## Instance Methods
#### Tree Maintenance
- `init(value: T)`: Initialize a new tree (containing the specified value at the root)
- `func addChild(value: T) -> Node`: Append a new node (containing the specified value) to our list of children
#### Node Retrieval
- `func getChildren(traversal: Traversal, maxDepth: UInt, excludeValues: ValueSet) -> [Node]`: Fetch the child nodes of the node. Optional list of values for children to be excluded, along with their progeny. Traversal is `.breadthFirst` by default. NOTE: breadth-first with `maxDepth` not yet supported.
- `func getSelfAndChildren(traversal: Traversal, maxDepth: UInt, excludeValues: ValueSet) -> [Node]`: Fetch the node and its child nodes. Optional list of values for nodes to be excluded, along with their progeny. Traversal is `.breadthFirst` by default. Self is at the first level of depth, so `maxDepth: 0` returns `[]`. NOTE: breadth-first with `maxDepth` not yet supported.
- `func getParent(excludeValues: ValueSet) -> Node?`: Return the immediate parent node, if any. Optional list of parent values to be excluded. A match will cause this function to return nil.
- `func getParents(maxDepth: UInt, excludeValues: ValueSet) -> [Node]`: Return the parent nodes, starting with immediate parent. Optional list of parent values to be excluded. A match will exclude further ancestors. Optional limit on depth.
#### Node Search
- `func getFirst(for: T) -> Node?`: Traverse from the current node to find the first node with the specified value. Traversal is breadth-first.
- `func getFirstChild(for: T) -> Node?`: Traverse the children from the current node to find the first child (grandchild, etc.) with the specified value. Traversal is breadth-first.
#### Iterators
- `func makeChildIterator(excludeValues: ValueSet) -> AnyIterator`: Create a iterator to traverse through the children (grandchildren, etc.) of the current node. Traversal is breadth-first. With short circuit of child branches on exclude filter.
- `func makeParentIterator() -> AnyIterator`: Create a iterator to traverse up the tree through the parents of the current node, starting with the most recent parent, if any.
#### Value retrieval
- `func getChildValues(traversal: Traversal, maxDepth: UInt, excludeValues: ValueSet) -> [T]`: Fetch the values of the child nodes. Optional list of values for children to be excluded, along with their progeny. Traversal is `.breadthFirst` by default. NOTE: breadth-first with `maxDepth` not yet supported.
- `func getSelfAndChildValues(excludeValues: ValueSet) -> [T]`: Fetch values for the node and its child nodes. Includes value of current node. Optional list of values for nodes to be excluded, along with their progeny. Self is at the first level of depth, so `maxDepth: 0` returns `[]`. Traversal is breadth-first, by default. NOTE: breadth-first with `maxDepth` not yet supported.
- `func getParentValue(excludeValues: ValueSet) -> T?`: Return the value of the immediate parent node, if any. Optional list of parent values to be excluded. A match will cause this function to return nil.
- `func getParentValues(maxDepth: UInt, excludeValues: ValueSet) -> [T]`: Return the values of the parent nodes, starting with immediate parent. Optional list of parent values to be excluded. A match will exclude further ancestors. Optional limit on depth.
## See Also
This library is a member of the _OpenAlloc Project_.
* [_OpenAlloc_](https://openalloc.github.io) - product website for all the _OpenAlloc_ apps and libraries
* [_OpenAlloc Project_](https://github.com/openalloc) - Github site for the development project, including full source code
## License
Copyright 2021, 2022 OpenAlloc LLC
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
## Contributing
Contributions are welcome. You are encouraged to submit pull requests to fix bugs, improve documentation, or offer new features.
The pull request need not be a production-ready feature or fix. It can be a draft of proposed changes, or simply a test to show that expected behavior is buggy. Discussion on the pull request can proceed from there.
Contributions should ultimately have adequate test coverage. See tests for current entities to see what coverage is expected.