/*
    * Licensed to the Apache Software Foundation (ASF) under one or more
    * contributor license agreements.  See the NOTICE file distributed with
    * this work for additional information regarding copyright ownership.
    * The ASF licenses this file to You under the Apache License, Version 2.0
    * (the "License"); you may not use this file except in compliance with
    * the License.  You may obtain a copy of the License at
    *
    *      http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package org.apache.commons.statistics.examples.distribution;
  
  import java.util.ArrayList;
  import java.util.List;
  import org.apache.commons.statistics.distribution.ContinuousDistribution;
  import org.apache.commons.statistics.distribution.LogNormalDistribution;
  import picocli.CommandLine.ArgGroup;
  import picocli.CommandLine.Command;
  import picocli.CommandLine.Option;
  
  /**
   * Command for the {@link LogNormalDistribution}.
   */
  @Command(name = "lognormal",
           aliases = {"lnorm", "logn"},
           description = "Log-normal distribution.",
           subcommands = {
               LogNormalCommand.Check.class,
               LogNormalCommand.PDF.class,
               LogNormalCommand.LPDF.class,
               LogNormalCommand.CDF.class,
               LogNormalCommand.SF.class,
               LogNormalCommand.ICDF.class,
               LogNormalCommand.ISF.class,
           })
  class LogNormalCommand extends AbstractDistributionCommand {
  
      /** Base command for the distribution that defines the parameters. */
      private abstract static class BaseCommand extends AbstractContinuousDistributionCommand {
          /** Distribution parameters. */
          @ArgGroup(validate = false, heading = "Distribution parameters:%n", order = 1)
          private Params params = new Params();
  
          /** Parameters class. */
          static class Params {
              /** The distribution mean. */
              @Option(names = {"-m", "--mu", "--mean"},
                      arity = "1..*",
                      split = ",",
                      description = {"mean of variable's natural logarithm (default: ${DEFAULT-VALUE})."})
              private double[] mu = {0};
  
              /** The distribution sigma. */
              @Option(names = {"-s", "--sigma"},
                      arity = "1..*",
                      split = ",",
                      description = {"standard deviation of variable's natural logarithm (default: ${DEFAULT-VALUE})."})
              private double[] sigma = {0.125, 0.25, 0.5, 1, 1.5, 10};
          }
  
          /** Extend the options to set the default values for this distribution. */
          static final class Options extends ContinuousDistributionOptions {
              /** Set defaults. */
              private Options() {
                  min = 0;
                  max = 3;
              }
          }
  
          @Override
          protected List<Distribution<ContinuousDistribution>> getDistributions() {
              double[] mean = params.mu;
              double[] sigma = params.sigma;
              final int n = DistributionUtils.validateLengths(mean.length, sigma.length);
  
              mean = DistributionUtils.expandToLength(mean, n);
              sigma = DistributionUtils.expandToLength(sigma, n);
  
              // Create distributions
              final ArrayList<Distribution<ContinuousDistribution>> list = new ArrayList<>();
              for (int i = 0; i < n; i++) {
                  final ContinuousDistribution d = LogNormalDistribution.of(mean[i], sigma[i]);
                  list.add(new Distribution<>(d, "mu=" + mean[i] + ",sigma=" + sigma[i]));
              }
              return list;
          }
      }
  
      /** Base command for the distribution that defines the parameters. */
      private abstract static class ProbabilityCommand extends BaseCommand {
          /** The distribution options. */
          @ArgGroup(validate = false, heading = "Evaluation options:%n", order = 2)
          private Options distributionOptions = new Options();
 
         @Override
         protected DistributionOptions getDistributionOptions() {
             return distributionOptions;
         }
     }
 
     /** Base command for the distribution that defines the parameters for inverse probability functions. */
     private abstract static class InverseProbabilityCommand extends BaseCommand {
         /** The distribution options. */
         @ArgGroup(validate = false, heading = "Evaluation options:%n", order = 2)
         private InverseContinuousDistributionOptions distributionOptions = new InverseContinuousDistributionOptions();
 
         @Override
         protected DistributionOptions getDistributionOptions() {
             return distributionOptions;
         }
     }
 
     /** Verification checks command. */
     @Command(name = "check",
              hidden = true,
              description = "Log-normal distribution verification checks.")
     static class Check extends ProbabilityCommand {}
 
     /** PDF command. */
     @Command(name = "pdf",
              description = "Log-normal distribution PDF.")
     static class PDF extends ProbabilityCommand {}
 
     /** LPDF command. */
     @Command(name = "lpdf",
              description = "Log-normal distribution natural logarithm of the PDF.")
     static class LPDF extends ProbabilityCommand {}
 
     /** CDF command. */
     @Command(name = "cdf",
              description = "Log-normal distribution CDF.")
     static class CDF extends ProbabilityCommand {}
 
     /** SF command. */
     @Command(name = "sf",
              description = "Log-normal distribution survival probability.")
     static class SF extends ProbabilityCommand {}
 
     /** ICDF command. */
     @Command(name = "icdf",
              description = "Log-normal distribution inverse CDF.")
     static class ICDF extends InverseProbabilityCommand {}
 
     /** ISF command. */
     @Command(name = "isf",
              description = "Log-normal distribution inverse SF.")
     static class ISF extends InverseProbabilityCommand {}
 }