logprob 0.3.0

A wrapper around floats to handle log probabilities
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

# logprob

[![crates.io](https://img.shields.io/crates/v/logprob.svg)](https://crates.io/crates/logprob)
[![docs.rs](https://docs.rs/logprob/badge.svg)](https://docs.rs/logprob)
![license](https://img.shields.io/crates/l/logprob.svg)

This crate defines a basic `LogProb` wrapper for floats. The struct is designed
so that only values that are coherent for a log-probability are acceptable. This
means that `LogProb` can store:

- Any finite negative float value (e.g. -0.23, -32535.05, -66.0).
- Negative infinity (corresponding to 0.0 probability)
- 0.0 _and_ -0.0.

The crate is intended for careful implementations of computations involving log-probabilities.

## Features

- A way to add `LogProb`s (equivalent to taking the product of their
  corresponding raw probabilities)
- Take the product of a `LogProb` and an unsigned integer (e.g. equivalent to $p^n$).
- `Ord`, `Eq` and `Hash` trait on `LogProb` as there is no `NaN`.
- A relatively efficient implementation of [LogSumExp](https://en.wikipedia.org/wiki/LogSumExp)
  for slices and iterators.
- `no_std` support by disabling the `std` feature flag (allocations are required
  for some functions, which can be enabled with the `alloc` feature flag).

For examples, see the documentation.