BaseSignificanceResult.java

  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.inference;

  18. /**
  19.  * Base implementation for the result of a test for significance.
  20.  *
  21.  * @since 1.1
  22.  */
  23. class BaseSignificanceResult implements SignificanceResult {
  24.     /** Test statistics. */
  25.     private final double statistic;
  26.     /** p-value. */
  27.     private final double p;

  28.     /**
  29.      * Create an instance.
  30.      *
  31.      * @param statistic Test statistic.
  32.      * @param p Result p-value.
  33.      */
  34.     BaseSignificanceResult(double statistic, double p) {
  35.         this.statistic = statistic;
  36.         this.p = p;
  37.     }

  38.     @Override
  39.     public double getStatistic() {
  40.         return statistic;
  41.     }

  42.     @Override
  43.     public double getPValue() {
  44.         return p;
  45.     }
  46. }