You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
gods/README.md

62 lines
1.6 KiB
Markdown

9 years ago
[![Build Status](https://travis-ci.org/emirpasic/gods.svg)](https://travis-ci.org/emirpasic/gods)
# GoDS (Go Data Structures)
9 years ago
Implementation of various data structures in Go.
## Implementations
- Sets:
- HashSet (unordered)
- TreeSet (ordered)
- Stacks:
- LinkedListStack
- ArrayStack
- Maps:
- HashMap (unordered)
- TreeMap (ordered)
- Tree:
- RedBlackTree
## Motivations
9 years ago
Collections and data structures found in other languages: Java Collections, C++ Standard Template Library (STL) containers, Qt Containers, etc.
## Goals
9 years ago
**Fast algorithms**:
- Based on decades of knowledge and experiences of other libraries mentioned below.
9 years ago
**Memory efficient algorithms**:
- Avoiding to keep consume memory by using optimal algorithms and data structures for the given set of problems.
9 years ago
**Easy to use library**:
- Well-structued library with minimalistic set of atomic operations from which more complex operations can be crafted.
9 years ago
**Stable library**:
- Only additions are permitted keeping the library backward compatible.
9 years ago
**Solid documentation and examples**:
- TODO
9 years ago
**Production ready**:
- TODO
There is often a tug of war between speed and memory when crafting algorithms. We choose to optimize for speed in most cases within reasonable limits on memory consumption.
9 years ago
## Testing and Benchmarking
9 years ago
`go test -v -bench . -benchmem -benchtime 1s ./...`
## License
Copyright (c) Emir Pasic, All rights reserved.
9 years ago
GNU Lesser General Public License Version 3, see [LICENSE](https://github.com/emirpasic/gods/blob/master/LICENSE) for more details.