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

Java example source code file (Product.java)

This example Java source code file (Product.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, nullargumentexception, override, product, serializable, weightedevaluation

The Product.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,
 * 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.math3.stat.descriptive.summary;

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.stat.descriptive.WeightedEvaluation;
import org.apache.commons.math3.util.FastMath;
import org.apache.commons.math3.util.MathUtils;

/**
 * Returns the product of the available values.
 * <p>
 * If there are no values in the dataset, then 1 is returned.
 *  If any of the values are
 * <code>NaN, then NaN is returned.

* <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 Product extends AbstractStorelessUnivariateStatistic implements Serializable, WeightedEvaluation { /** Serializable version identifier */ private static final long serialVersionUID = 2824226005990582538L; /**The number of values that have been added */ private long n; /** * The current Running Product. */ private double value; /** * Create a Product instance */ public Product() { n = 0; value = 1; } /** * Copy constructor, creates a new {@code Product} identical * to the {@code original} * * @param original the {@code Product} instance to copy * @throws NullArgumentException if original is null */ public Product(Product original) throws NullArgumentException { copy(original, this); } /** * {@inheritDoc} */ @Override public void increment(final double d) { value *= d; n++; } /** * {@inheritDoc} */ @Override public double getResult() { return value; } /** * {@inheritDoc} */ public long getN() { return n; } /** * {@inheritDoc} */ @Override public void clear() { value = 1; n = 0; } /** * Returns the product 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.

* * @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 product of the values or 1 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 product = Double.NaN; if (test(values, begin, length, true)) { product = 1.0; for (int i = begin; i < begin + length; i++) { product *= values[i]; } } return product; } /** * <p>Returns the weighted product of the entries in the specified portion of * the input array, or <code>Double.NaN if the designated subarray * is empty.</p> * * <p>Throws MathIllegalArgumentException if any of the following are true: * <ul>
  • the values array is null
  • * <li>the weights array is null * <li>the weights array does not have the same length as the values array * <li>the weights array contains one or more infinite values * <li>the weights array contains one or more NaN values * <li>the weights array contains negative values * <li>the start and length arguments do not determine a valid array * </ul>

    * * <p>Uses the formula,
         *    weighted product = ∏values[i]<sup>weights[i]
         * </pre>
         * that is, the weights are applied as exponents when computing the weighted product.</p>
         *
         * @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 the product of the values or 1 if length = 0
         * @throws MathIllegalArgumentException if the parameters are not valid
         * @since 2.1
         */
        public double evaluate(final double[] values, final double[] weights,
            final int begin, final int length) throws MathIllegalArgumentException {
            double product = Double.NaN;
            if (test(values, weights, begin, length, true)) {
                product = 1.0;
                for (int i = begin; i < begin + length; i++) {
                    product *= FastMath.pow(values[i], weights[i]);
                }
            }
            return product;
        }
    
        /**
         * <p>Returns the weighted product of the entries in the input array.

    * * <p>Throws MathIllegalArgumentException if any of the following are true: * <ul>
  • the values array is null
  • * <li>the weights array is null * <li>the weights array does not have the same length as the values array * <li>the weights array contains one or more infinite values * <li>the weights array contains one or more NaN values * <li>the weights array contains negative values * </ul>

    * * <p>Uses the formula,
         *    weighted product = ∏values[i]<sup>weights[i]
         * </pre>
         * that is, the weights are applied as exponents when computing the weighted product.</p>
         *
         * @param values the input array
         * @param weights the weights array
         * @return the product of the values or Double.NaN if length = 0
         * @throws MathIllegalArgumentException if the parameters are not valid
         * @since 2.1
         */
        public double evaluate(final double[] values, final double[] weights)
        throws MathIllegalArgumentException {
            return evaluate(values, weights, 0, values.length);
        }
    
    
        /**
         * {@inheritDoc}
         */
        @Override
        public Product copy() {
            Product result = new Product();
            // No try-catch or advertised exception because args are valid
            copy(this, result);
            return result;
        }
    
        /**
         * Copies source to dest.
         * <p>Neither source nor dest can be null.

    * * @param source Product to copy * @param dest Product to copy to * @throws NullArgumentException if either source or dest is null */ public static void copy(Product source, Product 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 Product.java source code file:



    my book on functional programming

     

    new blog posts

     

    Copyright 1998-2019 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.