1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.statistics.examples.distribution;
18
19 import picocli.CommandLine.Option;
20
21 /**
22 * Options for inverse probability functions of discrete distributions.
23 * Applies to functions x=real in [0, 1] and f(x)=integer.
24 */
25 class InverseDiscreteDistributionOptions extends DistributionOptions {
26 /** The minimum probability to evaluate. */
27 @Option(names = { "--min" },
28 description = {"Minimum probability to evaluate (default: ${DEFAULT-VALUE})."})
29 protected double min;
30
31 /** The maximum probability to evaluate. */
32 @Option(names = { "--max" },
33 description = {"Maximum probability to evaluate (default: ${DEFAULT-VALUE})."})
34 protected double max = 1;
35
36 /** The number of steps from minimum to the maximum. */
37 @Option(names = { "--steps" },
38 description = {"Number of steps from the minimum to the maximum (default: ${DEFAULT-VALUE})."})
39 protected int steps = 100;
40
41 /** The single point to evaluate. */
42 @Option(names = { "-x", "--point" },
43 arity = "1..*",
44 split = ",",
45 description = {"Point to evaluate (overrides input range)."})
46 protected double[] x;
47
48 /** The format for the evaluated probability. */
49 @Option(names = { "--pformat" },
50 description = {"Format for the evaluated probability (default: ${DEFAULT-VALUE})."})
51 protected String pformat = "%.6g";
52 }