# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [v0.10.0] - 2023-04-19

### added

- `Iptrie.minimize/1` as convenience wrapper for `Iptrie.minimize/2`.

### fixed

- error handling for `Iptrie.minimize/2`, consistent with other functions

## [v0.9.0] - 2023-04-16


### added

- `Iptrie.minimize/2` to easily minimize an Iptrie.

### fixed

- some documentation

## [v0.8.0] - 2022-02-20

### added

- `Iptrie.iana_special/2` which delegates to `Iptrie.Iana.lookup/2`

### changed

- updated Pfx to latest version, so IPv6 is formatted with shorthand notation
    - tests were modified accordingly


## [v0.7.0] - 2022-01-16

### added

- `Iptrie.Iana` module to access IANA IPv4/6 Specical-Purpose Address Registries

### changed

- updated dependency Pfx to v0.12.0

### fixed

- typespec for `t:Iptrie.t/0` by adding optional integer -> Radix.t


## [v0.6.0] - 2021-12-04

### added

- `Iptrie.get_and_update/3` to do update a key,value-pair in one go.

### changed

- `Iptrie.less/3` now can optionally exclude search key from results.
- `Iptrie.more/3` now can optionally exclude search key from results.

### fixed

- Readme examples write their files to assets/, not img/


## v0.5.0 - 2021-07-25

### added
- `Iptrie.prune/3` to prune an Iptrie, optionally doing so recursively

### changed
- Pulled in `Radix` 0.3.0, for `Radix.prune/3`


## v0.4.0 - 2021-07-20

## added
- `Iptrie.count/1`, return count of all entries in an Iptrie
- `Iptrie.count/2`, return count of entries for given `type`
- `Iptrie.drop/2`, drop some prefixes from the Iptrie
- `Iptrie.empty?/1`, says if a given Iptrie is empty or not
- `Iptrie.empty?/2`, says if a particular radix tree of `type` is empty or not
- `Iptrie.get/3`, gets a prefix or returns default if prefix was not found
- `Iptrie.has_prefix?/2`, says whether given prefix is present in an Iptrie
- `Iptrie.has_type?/2`, says whether or not trie has a given type
- `Iptrie.merge/2`, merges two Iptrie's
- `Iptrie.merge/3`, merges two Iptrie's with conflict resolution
- `Iptrie.pop/3`, returns popped pfx,val and new trie
- `Iptrie.radix/2`, get a radix tree by type from an Iptrie, or a new empty one
- `Iptrie.split/3`, split one trie into two (optionally using lpm)
- `Iptrie.take/3`, return new Iptrie contains just the given keys
- `Iptrie.types/1`, returns a list of available types or maxlen's in the trie

## changed
- Merged [#1](https://github.com/hertogp/iptrie/pull/1) misc doc changes
- Pulled in `Pfx` 0.5.0
- Pulled in `Radix` 0.2.0
- Updated deps with new versions of `Pfx` and `Radix`
- `Iptrie.delete/2` only deletes a single prefix, now `Iptrie.drop/2` is available
- `Iptrie.filter/2` user callback now takes a `t:Pfx.t/0` instead of bitstring radix key
- `Iptrie.get/2` no longer gets a list of prefixes, just 1 prefix at a time
- `Iptrie.keys/2` returns keys for a single type only
- `Iptrie.reduce/3` user callback now takes a `t:Pfx.t/0` instead of bitstring radix key
- `Iptrie.reduce/4` takes a single type only, not a list of types
- `Iptrie.reduce/4` user callback now takes a `t:Pfx.t/0` instead of bitstring radix key
- `Iptrie.to_list/2` returns prefix,value-pairs for a single type only
- `Iptrie.values/2` returns values for a single radix tree type only


## v0.3.0 - 2021-07-06

### added
- `Iptrie.fetch/2`, `Iptrie.fetch!/2`
- `Iptrie.find/2`, `Iptrie.find!/2`
- `Iptrie.filter/2`


## v0.2.0 - 2021-07-05

### added
- `Iptrie.radix/2`
- `Iptrie.reduce/3`, `Iptrie.reduce/4`
- `Iptrie.to_list/1`, `Iptrie.to_list/2`

## v0.1.0 - 2021-07-05

- Initial public version