Skip to content

Chore/improve readme #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
patrick-skowronek wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Chore/improve readme #18

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ef55eef
Merge pull request #17 from samply/develop
enola-dkfz Nov 26, 2025
ec9634a
chore: improve readme
patrick-skowronek Dec 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,21 +24,20 @@ In this section the "installation" and usage of Samply.Laplace is described.
To use Samply.Laplace in your project, please include the following dependency in your `Cargo.toml`:

```
laplace_rs = {version = "0.2.0", git = "https://github.com/samply/laplace-rs.git", branch = "main"}
laplace_rs = {version = "0.6.0", git = "https://github.com/samply/laplace-rs.git", branch = "main"}
```

### Example Usage

Using Samply.Laplace library:

```rust
use laplace_rs::{ObfCache, get_from_cache_or_privatize, Bin, ObfuscateBelow10Mode};
use laplace_rs::{ errors::LaplaceError, ObfCache, get_from_cache_or_privatize, ObfuscateBelow10Mode};

const DELTA: f64 = 1.;
const EPSILON: f64 = 0.1;
const MU: f64 = 0.;
const ROUNDING_STEP: usize = 10;
const domain_limit = None;
const DOMAIN_LIMIT = None;


fn obfuscate -> Result<u64, LaplaceError> {
Expand All @@ -56,7 +55,7 @@ fn obfuscate -> Result<u64, LaplaceError> {
false, // A flag indicating whether zero counts should be obfuscated.
ObfuscateBelow10Mode::Ten, // 0 - return 0, 1 - return 10, 2 - obfuscate using Laplace distribution and rounding
ROUNDING_STEP, // The granularity of the rounding.
domain_limit, // Optional limitation to the domain of the Laplace distributions
DOMAIN_LIMIT, // Optional limitation to the domain of the Laplace distributions
&mut rng, // A secure random generator for seeded randomness.
)?;

Expand Down