|
Commons Math example source code file (AbstractUnivariateStatistic.java)
The Commons Math AbstractUnivariateStatistic.java source code/* * 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.math.stat.descriptive; import org.apache.commons.math.MathRuntimeException; /** * Abstract base class for all implementations of the * {@link UnivariateStatistic} interface. * <p> * Provides a default implementation of <code>evaluate(double[]), * delegating to <code>evaluate(double[], int, int) in the natural way. * </p> * <p> * Also includes a <code>test method that performs generic parameter * validation for the <code>evaluate methods. * * @version $Revision: 894705 $ $Date: 2009-12-30 15:24:54 -0500 (Wed, 30 Dec 2009) $ */ public abstract class AbstractUnivariateStatistic implements UnivariateStatistic { /** * {@inheritDoc} */ public double evaluate(final double[] values) { test(values, 0, 0); return evaluate(values, 0, values.length); } /** * {@inheritDoc} */ public abstract double evaluate(final double[] values, final int begin, final int length); /** * {@inheritDoc} */ public abstract UnivariateStatistic copy(); /** * This method is used by <code>evaluate(double[], int, int) methods * to verify that the input parameters designate a subarray of positive length. * <p> * <ul> * <li>returns false if the array is non-null, but
* <code>length is 0.
* </ul>
*
* @param values the input array
* @param weights the weights array
* @param begin index of the first array element to include
* @param length the number of elements to include
* @return true if the parameters are valid and designate a subarray of positive length
* @throws IllegalArgumentException if the indices are invalid or the array is null
* @since 2.1
*/
protected boolean test(
final double[] values,
final double[] weights,
final int begin,
final int length) {
if (weights == null) {
throw MathRuntimeException.createIllegalArgumentException("input weights array is null");
}
if (weights.length != values.length) {
throw MathRuntimeException.createIllegalArgumentException(
"Different number of weights and values");
}
boolean containsPositiveWeight = false;
for (int i = begin; i < begin + length; i++) {
if (Double.isNaN(weights[i])) {
throw MathRuntimeException.createIllegalArgumentException(
"NaN weight at index {0}", i);
}
if (Double.isInfinite(weights[i])) {
throw MathRuntimeException.createIllegalArgumentException(
"Infinite weight at index {0}", i);
}
if (weights[i] < 0) {
throw MathRuntimeException.createIllegalArgumentException(
"negative weight {0} at index {1} ", weights[i], i);
}
if (!containsPositiveWeight && weights[i] > 0.0) {
containsPositiveWeight = true;
}
}
if (!containsPositiveWeight) {
throw MathRuntimeException.createIllegalArgumentException(
"weight array must contain at least one non-zero value");
}
return test(values, begin, length);
}
}
Other Commons Math examples (source code examples)Here is a short list of links related to this Commons Math AbstractUnivariateStatistic.java source code file: |
... this post is sponsored by my books ... | |
#1 New Release! |
FP Best Seller |
Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.
A percentage of advertising revenue from
pages under the /java/jwarehouse
URI on this website is
paid back to open source projects.