org.hipparchus.stat.descriptive.StorelessMultivariateStatistic Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hipparchus-stat Show documentation

The Hipparchus statistics module

There is a newer version: 3.1

/*
 * 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.
 */

/*
 * This is not the original file distributed by the Apache Software Foundation
 * It has been modified by the Hipparchus project
 */
package org.hipparchus.stat.descriptive;

/**
 * Base interface implemented by storeless multivariate statistics.
 */
public interface StorelessMultivariateStatistic {

    /**
     * Updates the internal state of the statistic to reflect
     * the addition of the new value.
     *
     * @param d the new value
     */
    void increment(double[] d);

    /**
     * Returns the current value of the Statistic.
     * @return value of the statistic, Double.NaN if it
     * has been cleared or just instantiated.
     */
    double[] getResult();

    /**
     * Returns the number of values that have been added.
     * @return the number of values.
     */
    long getN();

    /**
     * Clears the internal state of the statistic.
     */
    void clear();

    /**
     * Returns the dimension of the statistic.
     * @return the dimension of the statistic
     */
    int getDimension();
}