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

Commons Math example source code file (HarmonicFunction.java)

This example Commons Math source code file (HarmonicFunction.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

differentiableunivariaterealfunction, differentiableunivariaterealfunction, harmonicfunction, harmonicfunction

The Commons Math HarmonicFunction.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.optimization.fitting;

import org.apache.commons.math.analysis.DifferentiableUnivariateRealFunction;

/** Harmonic function of the form <code>f (t) = a cos (ω t + φ).
 * @version $Revision: 786479 $ $Date: 2009-06-19 08:36:16 -0400 (Fri, 19 Jun 2009) $
 * @since 2.0
 */
public class HarmonicFunction implements DifferentiableUnivariateRealFunction {

    /** Amplitude a. */
    private final double a;

    /** Pulsation ω. */
    private final double omega;

    /** Phase φ. */
    private final double phi;

    /** Simple constructor.
     * @param a amplitude
     * @param omega pulsation
     * @param phi phase
     */
    public HarmonicFunction(double a, double omega, double phi) {
        this.a     = a;
        this.omega = omega;
        this.phi   = phi;
    }

    /** {@inheritDoc} */
    public double value(double x) {
        return a * Math.cos(omega * x + phi);
    }

    /** {@inheritDoc} */
    public HarmonicFunction derivative() {
        return new HarmonicFunction(a * omega, omega, phi + Math.PI / 2);
    }

    /** Get the amplitude a.
     * @return amplitude a;
     */
    public double getAmplitude() {
        return a;
    }

    /** Get the pulsation ω.
     * @return pulsation ω
     */
    public double getPulsation() {
        return omega;
    }

    /** Get the phase φ.
     * @return phase φ
     */
    public double getPhase() {
        return phi;
    }

}

Other Commons Math examples (source code examples)

Here is a short list of links related to this Commons Math HarmonicFunction.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.