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 * https://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
18 /*
19 * This is not the original file distributed by the Apache Software Foundation
20 * It has been modified by the Hipparchus project
21 */
22 package org.hipparchus.stat.descriptive;
23
24 /**
25 * Base interface implemented by storeless multivariate statistics.
26 */
27 public interface StorelessMultivariateStatistic {
28
29 /**
30 * Updates the internal state of the statistic to reflect
31 * the addition of the new value.
32 *
33 * @param d the new value
34 */
35 void increment(double[] d);
36
37 /**
38 * Returns the current value of the Statistic.
39 * @return value of the statistic, <code>Double.NaN</code> if it
40 * has been cleared or just instantiated.
41 */
42 double[] getResult();
43
44 /**
45 * Returns the number of values that have been added.
46 * @return the number of values.
47 */
48 long getN();
49
50 /**
51 * Clears the internal state of the statistic.
52 */
53 void clear();
54
55 /**
56 * Returns the dimension of the statistic.
57 * @return the dimension of the statistic
58 */
59 int getDimension();
60 }