alvinalexander.com | career | drupal | java | mac | mysql | perl | scala | uml | unix  

Commons Math example source code file (BinaryFunction.java)

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

Java - Commons Math tags/keywords

add, atan2, binaryfunction, binaryfunction, bivariaterealfunction, composablefunction, composablefunction, divide, functionevaluationexception, functionevaluationexception, multiply, override, override, subtract

The Commons Math BinaryFunction.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.analysis;

import org.apache.commons.math.FunctionEvaluationException;



/**
 * Base class for {@link BivariateRealFunction} that can be composed with other functions.
 *
 * @since 2.1
 * @version $Revision: 924453 $ $Date: 2010-03-17 16:05:20 -0400 (Wed, 17 Mar 2010) $
 */
public abstract class BinaryFunction implements BivariateRealFunction {

    /** The + operator method wrapped as a {@link BinaryFunction}. */
    public static final BinaryFunction ADD = new BinaryFunction() {
        /** {@inheritDoc} */
        @Override
        public double value(double x, double y) {
            return x + y;
        }
    };

    /** The - operator method wrapped as a {@link BinaryFunction}. */
    public static final BinaryFunction SUBTRACT = new BinaryFunction() {
        /** {@inheritDoc} */
        @Override
        public double value(double x, double y) {
            return x - y;
        }
    };

    /** The * operator method wrapped as a {@link BinaryFunction}. */
    public static final BinaryFunction MULTIPLY = new BinaryFunction() {
        /** {@inheritDoc} */
        @Override
        public double value(double x, double y) {
            return x * y;
        }
    };

    /** The / operator method wrapped as a {@link BinaryFunction}. */
    public static final BinaryFunction DIVIDE = new BinaryFunction() {
        /** {@inheritDoc} */
        @Override
        public double value(double x, double y) {
            return x / y;
        }
    };

    /** The {@code Math.pow} method wrapped as a {@link BinaryFunction}. */
    public static final BinaryFunction POW = new BinaryFunction() {
        /** {@inheritDoc} */
        @Override
        public double value(double x, double y) {
            return Math.pow(x, y);
        }
    };

    /** The {@code Math.atan2} method wrapped as a {@link BinaryFunction}. */
    public static final BinaryFunction ATAN2 = new BinaryFunction() {
        /** {@inheritDoc} */
        @Override
        public double value(double x, double y) {
            return Math.atan2(x, y);
        }
    };

    /** {@inheritDoc} */
    public abstract double value(double x, double y) throws FunctionEvaluationException;

    /** Get a composable function by fixing the first argument of the instance.
     * @param fixedX fixed value of the first argument
     * @return a function such that {@code f.value(y) == value(fixedX, y)}
     */
    public ComposableFunction fix1stArgument(final double fixedX) {
        return new ComposableFunction() {
            @Override
            /** {@inheritDoc} */
            public double value(double x) throws FunctionEvaluationException {
                return BinaryFunction.this.value(fixedX, x);
            }
        };
    }

    /** Get a composable function by fixing the second argument of the instance.
     * @param fixedY fixed value of the second argument
     * @return a function such that {@code f.value(x) == value(x, fixedY)}
     */
    public ComposableFunction fix2ndArgument(final double fixedY) {
        return new ComposableFunction() {
            @Override
            /** {@inheritDoc} */
            public double value(double x) throws FunctionEvaluationException {
                return BinaryFunction.this.value(x, fixedY);
            }
        };
    }

}

Other Commons Math examples (source code examples)

Here is a short list of links related to this Commons Math BinaryFunction.java source code file:

... this post is sponsored by my books ...

#1 New Release!

FP Best Seller

 

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.