home | career | drupal | java | mac | mysql | perl | scala | uml | unix  

Java example source code file (Max.java)

This example Java source code file (Max.java) is included in the alvinalexander.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Learn more about this Java project at its project page.

Java - Java tags/keywords

abstractstorelessunivariatestatistic, mathillegalargumentexception, max, nullargumentexception, override, serializable

The Max.java Java example 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,
 * See the License for the specific language governing permissions and
 * limitations under the License.
package org.apache.commons.math3.stat.descriptive.rank;

import java.io.Serializable;

import org.apache.commons.math3.exception.MathIllegalArgumentException;
import org.apache.commons.math3.exception.NullArgumentException;
import org.apache.commons.math3.stat.descriptive.AbstractStorelessUnivariateStatistic;
import org.apache.commons.math3.util.MathUtils;

 * Returns the maximum of the available values.
 * <p>
 * <ul>
 * <li>The result is NaN iff all values are NaN
 * (i.e. <code>NaN values have no impact on the value of the statistic).
 * <li>If any of the values equals Double.POSITIVE_INFINITY,
 * the result is <code>Double.POSITIVE_INFINITY.
 * </ul>

* <p> * <strong>Note that this implementation is not synchronized. If * multiple threads access an instance of this class concurrently, and at least * one of the threads invokes the <code>increment() or * <code>clear() method, it must be synchronized externally.

* */ public class Max extends AbstractStorelessUnivariateStatistic implements Serializable { /** Serializable version identifier */ private static final long serialVersionUID = -5593383832225844641L; /** Number of values that have been added */ private long n; /** Current value of the statistic */ private double value; /** * Create a Max instance */ public Max() { n = 0; value = Double.NaN; } /** * Copy constructor, creates a new {@code Max} identical * to the {@code original} * * @param original the {@code Max} instance to copy * @throws NullArgumentException if original is null */ public Max(Max original) throws NullArgumentException { copy(original, this); } /** * {@inheritDoc} */ @Override public void increment(final double d) { if (d > value || Double.isNaN(value)) { value = d; } n++; } /** * {@inheritDoc} */ @Override public void clear() { value = Double.NaN; n = 0; } /** * {@inheritDoc} */ @Override public double getResult() { return value; } /** * {@inheritDoc} */ public long getN() { return n; } /** * Returns the maximum of the entries in the specified portion of * the input array, or <code>Double.NaN if the designated subarray * is empty. * <p> * Throws <code>MathIllegalArgumentException if the array is null or * the array index parameters are not valid.</p> * <p> * <ul> * <li>The result is NaN iff all values are NaN * (i.e. <code>NaN values have no impact on the value of the statistic). * <li>If any of the values equals Double.POSITIVE_INFINITY, * the result is <code>Double.POSITIVE_INFINITY. * </ul>

* * @param values the input array * @param begin index of the first array element to include * @param length the number of elements to include * @return the maximum of the values or Double.NaN if length = 0 * @throws MathIllegalArgumentException if the array is null or the array index * parameters are not valid */ @Override public double evaluate(final double[] values, final int begin, final int length) throws MathIllegalArgumentException { double max = Double.NaN; if (test(values, begin, length)) { max = values[begin]; for (int i = begin; i < begin + length; i++) { if (!Double.isNaN(values[i])) { max = (max > values[i]) ? max : values[i]; } } } return max; } /** * {@inheritDoc} */ @Override public Max copy() { Max result = new Max(); // No try-catch or advertised exception because args are non-null copy(this, result); return result; } /** * Copies source to dest. * <p>Neither source nor dest can be null.

* * @param source Max to copy * @param dest Max to copy to * @throws NullArgumentException if either source or dest is null */ public static void copy(Max source, Max dest) throws NullArgumentException { MathUtils.checkNotNull(source); MathUtils.checkNotNull(dest); dest.setData(source.getDataRef()); dest.n = source.n; dest.value = source.value; } }

Other Java examples (source code examples)

Here is a short list of links related to this Java Max.java source code file:

my book on functional programming


new blog posts


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.