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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
|
=head1 NAME
nbdkit_parse_probability - parse probabilities for nbdkit
=head1 SYNOPSIS
#include <nbdkit-plugin.h>
int nbdkit_parse_probability (const char *what, const char *str,
double *ret);
=head1 DESCRIPTION
Use the C<nbdkit_parse_probability> utility function to parse
probabilities. Common formats understood include: C<"0.1">,
C<"1e-1">, C<"10%">, C<"1:10"> or C<"1/10">, which all mean a
probability of 1 in 10.
The C<what> parameter is printed in error messages to provide context.
The C<str> parameter is the probability string.
=head1 RETURN VALUE
On success the function returns C<0> and sets C<*ret>. The
probability is always a finite number E<ge> 0.0, but B<note the result
may be larger than 1.0> (for example if S<C<str == "200%">> then the
function will set S<C<*ret = 2.0>>). If you want to clamp the upper
bound the caller must do that.
On error, L<nbdkit_error(3)> is called and C<-1> is returned.
=head1 LANGUAGE BINDINGS
In L<nbdkit-ocaml-plugin(3)>:
NBDKit.parse_probability : string -> string -> float
In L<nbdkit-python-plugin(3)>:
import nbdkit
size = nbdkit.parse_probability(what, str)
In L<nbdkit-rust-plugin(3)>:
use nbdkit::*;
pub fn parse_probability(what: &str, s: &str) -> Result<f64>
=head1 HISTORY
C<nbdkit_parse_probability> was added in nbdkit 1.36.
=head1 SEE ALSO
L<nbdkit(1)>,
L<nbdkit_parse_bool(3)>,
L<nbdkit_parse_delay(3)>,
L<nbdkit_parse_int(3)>,
L<nbdkit_parse_size(3)>,
L<nbdkit-plugin(3)>,
L<nbdkit-filter(3)>,
L<nbdkit-error-filter(1)>,
L<nbdkit-evil-filter(1)>.
=head1 AUTHORS
Richard W.M. Jones
=head1 COPYRIGHT
Copyright Red Hat
|
