Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tranzystorekk/btree

Last synced: 21 days ago
JSON representation

Host: GitHub
URL: https://github.com/tranzystorekk/btree
Owner: tranzystorekk
Created: 2018-04-06T19:43:42.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2018-05-31T11:54:26.000Z (over 6 years ago)
Last Synced: 2023-10-28T06:24:42.740Z (about 1 year ago)
Language: Scala
Size: 989 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# B-tree

**Functional** implementation of B-tree structure in Scala.

## General Info

Functional implementation of the B-tree structure in the Scala language. It is a project implemented as part of the JPS (Symbolic processing languages) course at the EiTI Faculty of Warsaw University of Technology. Project implemented in a two-person team.

### Requirements

* Scala
* IntelliJ IDEA with the Scala plugin installed (optional)

## Build Project

* [sbt](https://www.scala-sbt.org/)

### Run

Use command ***sbt run*** in terminal, or execute the _run_ task in IntelliJ IDEA.

## Main Loop

Running project starts a main loop, which allows to use simple methods. It can show that b-tree really works. Those methods allow to use only integers, but b-tree can contain other comparable types.

##### Available methods:

* add [Int] - add value to BTree
* rm [Int] - remove value from BTree
* is [Int] - check if a value exists in BTree
* print - print a DFS view of BTree
* help - print help prompt
* exit - exit program

## Tests

In the src/test/scala directory are Unit Tests (written using the scalatest framework) for the implemented b-tree.

#### Samples of tests

```
When many values are inserted, BTree contains them.
```
```
When there are many values, and one is removed, then Btree no longer contains it.
```
```
When value is removed, BTree no longer contains it.
```

#### Running Tests:

Use command ***sbt test*** in terminal, or execute the _test_ task in IntelliJ IDEA.

## Scaladoc

Scaladoc in html version are stored in [docs/html](/docs/html/) directory

## How B-tree works

#### Example of b-tree

![btree_example](https://upload.wikimedia.org/wikipedia/commons/thumb/6/65/B-tree.svg/400px-B-tree.svg.png)

#### Insert Method

![Insert](http://staff.ustc.edu.cn/~csli/graduate/algorithms/book6/393_a.gif)

#### Delete Method

![Delete](http://www.euroinformatica.ro/documentation/programming/!!!Algorithms_CORMEN!!!/images/fig472_01_0.jpg)

## Authors

* **Marcin Puc**
* **Mateusz Wasiak**