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

Java example source code file (ComplexUtils.java)

This example Java source code file (ComplexUtils.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

complex, complexutils, mathillegalargumentexception

The ComplexUtils.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.complex;

import org.apache.commons.math3.exception.MathIllegalArgumentException;
import org.apache.commons.math3.exception.util.LocalizedFormats;
import org.apache.commons.math3.util.FastMath;

/**
 * Static implementations of common
 * {@link org.apache.commons.math3.complex.Complex} utilities functions.
 *
 */
public class ComplexUtils {

    /**
     * Default constructor.
     */
    private ComplexUtils() {}

    /**
     * Creates a complex number from the given polar representation.
     * <p>
     * The value returned is <code>r·ei·theta,
     * computed as <code>r·cos(theta) + r·sin(theta)i

* <p> * If either <code>r or theta is NaN, or * <code>theta is infinite, {@link Complex#NaN} is returned.

* <p> * If <code>r is infinite and theta is finite, * infinite or NaN values may be returned in parts of the result, following * the rules for double arithmetic.<pre> * Examples: * <code> * polar2Complex(INFINITY, π/4) = INFINITY + INFINITY i * polar2Complex(INFINITY, 0) = INFINITY + NaN i * polar2Complex(INFINITY, -π/4) = INFINITY - INFINITY i * polar2Complex(INFINITY, 5π/4) = -INFINITY - INFINITY i </code>

* * @param r the modulus of the complex number to create * @param theta the argument of the complex number to create * @return <code>r·ei·theta * @throws MathIllegalArgumentException if {@code r} is negative. * @since 1.1 */ public static Complex polar2Complex(double r, double theta) throws MathIllegalArgumentException { if (r < 0) { throw new MathIllegalArgumentException( LocalizedFormats.NEGATIVE_COMPLEX_MODULE, r); } return new Complex(r * FastMath.cos(theta), r * FastMath.sin(theta)); } /** * Convert an array of primitive doubles to an array of {@code Complex} objects. * * @param real Array of numbers to be converted to their {@code Complex} * equivalent. * @return an array of {@code Complex} objects. * * @since 3.1 */ public static Complex[] convertToComplex(double[] real) { final Complex c[] = new Complex[real.length]; for (int i = 0; i < real.length; i++) { c[i] = new Complex(real[i], 0); } return c; } }

Other Java examples (source code examples)

Here is a short list of links related to this Java ComplexUtils.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.