org.apache.commons.numbers.examples.jmh.complex

Class ComplexPerformance

java.lang.Object

org.apache.commons.numbers.examples.jmh.complex.ComplexPerformance

Direct Known Subclasses:

ComplexPerformance_jmhType_B1

public class ComplexPerformance
extends Object

Executes a benchmark to measure the speed of operations in the Complex class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ComplexPerformance.ComplexAndRealNumbers Contains an array of complex numbers and an array of real numbers.
static class	ComplexPerformance.ComplexNumbers Contains an array of complex numbers.
static class	ComplexPerformance.ComplexNumberSize Contains the size of numbers.
static class	ComplexPerformance.TwoComplexNumbers Contains two arrays of complex numbers.

Constructor Summary

Constructors

Constructor and Description
ComplexPerformance()

Method Summary

Modifier and Type	Method and Description
double[]	abs(ComplexPerformance.ComplexNumbers numbers)
double[]	absMathHypot(ComplexPerformance.ComplexNumbers numbers) This test demonstrates that the Math.hypot(double, double) method is not as fast as the custom implementation in abs().
Complex[]	acos(ComplexPerformance.ComplexNumbers numbers)
Complex[]	acosh(ComplexPerformance.ComplexNumbers numbers)
Complex[]	add(ComplexPerformance.TwoComplexNumbers numbers)
Complex[]	addReal(ComplexPerformance.ComplexAndRealNumbers numbers)
double[]	arg(ComplexPerformance.ComplexNumbers numbers)
Complex[]	asin(ComplexPerformance.ComplexNumbers numbers)
Complex[]	asinh(ComplexPerformance.ComplexNumbers numbers)
Complex[]	atan(ComplexPerformance.ComplexNumbers numbers)
Complex[]	atanh(ComplexPerformance.ComplexNumbers numbers)
Complex[]	baselineCopy(ComplexPerformance.ComplexNumbers numbers) Baseline the creation of the new array of numbers with a copy complex number.
Complex[]	baselineCopyArray(ComplexPerformance.ComplexNumbers numbers) Baseline the creation of a copy array of numbers.
Complex[]	baselineIdentity(ComplexPerformance.ComplexNumbers numbers) Baseline the creation of the new array of numbers with the same complex number (an identity).
Complex[]	baselineNewArray(ComplexPerformance.ComplexNumberSize numberSize) Baseline the creation of the new array of numbers.
Complex[]	conj(ComplexPerformance.ComplexNumbers numbers)
Complex[]	conj2(ComplexPerformance.ComplexNumbers numbers) Explicit benchmark without using a method reference.
Complex[]	cos(ComplexPerformance.ComplexNumbers numbers)
Complex[]	cosh(ComplexPerformance.ComplexNumbers numbers)
Complex[]	divide(ComplexPerformance.TwoComplexNumbers numbers)
Complex[]	divideReal(ComplexPerformance.ComplexAndRealNumbers numbers)
Complex[]	exp(ComplexPerformance.ComplexNumbers numbers)
double[]	imag(ComplexPerformance.ComplexNumbers numbers)
boolean[]	isFinite(ComplexPerformance.ComplexNumbers numbers)
boolean[]	isInfinite(ComplexPerformance.ComplexNumbers numbers)
boolean[]	isNaN(ComplexPerformance.ComplexNumbers numbers)
Complex[]	log(ComplexPerformance.ComplexNumbers numbers)
Complex[]	log10(ComplexPerformance.ComplexNumbers numbers)
Complex[]	multiply(ComplexPerformance.TwoComplexNumbers numbers)
Complex[]	multiplyReal(ComplexPerformance.ComplexAndRealNumbers numbers)
Complex[]	negate(ComplexPerformance.ComplexNumbers numbers)
double[]	norm(ComplexPerformance.ComplexNumbers numbers)
Complex[]	pow(ComplexPerformance.TwoComplexNumbers numbers)
Complex[]	powReal(ComplexPerformance.ComplexAndRealNumbers numbers)
Complex[]	proj(ComplexPerformance.ComplexNumbers numbers)
double[]	real(ComplexPerformance.ComplexNumbers numbers)
double[]	real2(ComplexPerformance.ComplexNumbers numbers) Explicit benchmark without using a method reference.
Complex[]	sin(ComplexPerformance.ComplexNumbers numbers)
Complex[]	sinh(ComplexPerformance.ComplexNumbers numbers)
Complex[]	sqrt(ComplexPerformance.ComplexNumbers numbers)
double[]	sqrtNorm(ComplexPerformance.ComplexNumbers numbers) This test demonstrates that the method used in abs() is not as fast as using square root of the norm.
Complex[]	subtract(ComplexPerformance.TwoComplexNumbers numbers)
Complex[]	subtractReal(ComplexPerformance.ComplexAndRealNumbers numbers)
Complex[]	tan(ComplexPerformance.ComplexNumbers numbers)
Complex[]	tanh(ComplexPerformance.ComplexNumbers numbers)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ComplexPerformance

public ComplexPerformance()

Method Detail

real2

public double[] real2(ComplexPerformance.ComplexNumbers numbers)

Explicit benchmark without using a method reference. This should run in the same time as real(ComplexNumbers). This is commented out as it exists for reference purposes.

conj2

public Complex[] conj2(ComplexPerformance.ComplexNumbers numbers)

Explicit benchmark without using a method reference. This should run in the same time as conj(ComplexNumbers). This is commented out as it exists for reference purposes.

baselineNewArray

public Complex[] baselineNewArray(ComplexPerformance.ComplexNumberSize numberSize)

Baseline the creation of the new array of numbers. This contains the baseline JMH overhead for all the benchmarks that create complex numbers. All other methods are expected to be slower than this.

baselineCopyArray

public Complex[] baselineCopyArray(ComplexPerformance.ComplexNumbers numbers)

Baseline the creation of a copy array of numbers. This is commented out as it provides no information other than to demonstrate that baselineCopy(ComplexNumbers) is not being optimised to a single array copy operation.

baselineIdentity

public Complex[] baselineIdentity(ComplexPerformance.ComplexNumbers numbers)

Baseline the creation of the new array of numbers with the same complex number (an identity).

Note: This runs much faster than baselineCopy(ComplexNumbers). This is attributed to the identity function not requiring that the fields of the complex are accessed unlike all other methods that do computations on the real and/or imaginary parts. The method is slower than a creation of a new empty array or a copy array thus contains the loop overhead of the benchmarks that create new numbers.

See Also:

baselineNewArray(ComplexNumberSize), baselineCopyArray(ComplexNumbers)

baselineCopy

public Complex[] baselineCopy(ComplexPerformance.ComplexNumbers numbers)

Baseline the creation of the new array of numbers with a copy complex number. This measures the overhead of creation of new complex numbers including field access to the real and imaginary parts.

isNaN

public boolean[] isNaN(ComplexPerformance.ComplexNumbers numbers)

isInfinite

public boolean[] isInfinite(ComplexPerformance.ComplexNumbers numbers)

isFinite

public boolean[] isFinite(ComplexPerformance.ComplexNumbers numbers)

real

public double[] real(ComplexPerformance.ComplexNumbers numbers)

imag

public double[] imag(ComplexPerformance.ComplexNumbers numbers)

abs

public double[] abs(ComplexPerformance.ComplexNumbers numbers)

arg

public double[] arg(ComplexPerformance.ComplexNumbers numbers)

norm

public double[] norm(ComplexPerformance.ComplexNumbers numbers)

sqrtNorm

public double[] sqrtNorm(ComplexPerformance.ComplexNumbers numbers)

This test demonstrates that the method used in abs() is not as fast as using square root of the norm. The C99 standard for the abs() function requires over/underflow protection in the intermediate computation and infinity edge case handling. This has a performance overhead.

absMathHypot

public double[] absMathHypot(ComplexPerformance.ComplexNumbers numbers)

This test demonstrates that the Math.hypot(double, double) method is not as fast as the custom implementation in abs().

conj

public Complex[] conj(ComplexPerformance.ComplexNumbers numbers)

negate

public Complex[] negate(ComplexPerformance.ComplexNumbers numbers)

proj

public Complex[] proj(ComplexPerformance.ComplexNumbers numbers)

cos

public Complex[] cos(ComplexPerformance.ComplexNumbers numbers)

cosh

public Complex[] cosh(ComplexPerformance.ComplexNumbers numbers)

exp

public Complex[] exp(ComplexPerformance.ComplexNumbers numbers)

log

public Complex[] log(ComplexPerformance.ComplexNumbers numbers)

log10

public Complex[] log10(ComplexPerformance.ComplexNumbers numbers)

sin

public Complex[] sin(ComplexPerformance.ComplexNumbers numbers)

sinh

public Complex[] sinh(ComplexPerformance.ComplexNumbers numbers)

sqrt

public Complex[] sqrt(ComplexPerformance.ComplexNumbers numbers)

tan

public Complex[] tan(ComplexPerformance.ComplexNumbers numbers)

tanh

public Complex[] tanh(ComplexPerformance.ComplexNumbers numbers)

acos

public Complex[] acos(ComplexPerformance.ComplexNumbers numbers)

acosh

public Complex[] acosh(ComplexPerformance.ComplexNumbers numbers)

asin

public Complex[] asin(ComplexPerformance.ComplexNumbers numbers)

asinh

public Complex[] asinh(ComplexPerformance.ComplexNumbers numbers)

atan

public Complex[] atan(ComplexPerformance.ComplexNumbers numbers)

atanh

public Complex[] atanh(ComplexPerformance.ComplexNumbers numbers)

pow

public Complex[] pow(ComplexPerformance.TwoComplexNumbers numbers)

multiply

public Complex[] multiply(ComplexPerformance.TwoComplexNumbers numbers)

divide

public Complex[] divide(ComplexPerformance.TwoComplexNumbers numbers)

add

public Complex[] add(ComplexPerformance.TwoComplexNumbers numbers)

subtract

public Complex[] subtract(ComplexPerformance.TwoComplexNumbers numbers)

powReal

public Complex[] powReal(ComplexPerformance.ComplexAndRealNumbers numbers)

multiplyReal

public Complex[] multiplyReal(ComplexPerformance.ComplexAndRealNumbers numbers)

divideReal

public Complex[] divideReal(ComplexPerformance.ComplexAndRealNumbers numbers)

addReal

public Complex[] addReal(ComplexPerformance.ComplexAndRealNumbers numbers)

subtractReal

public Complex[] subtractReal(ComplexPerformance.ComplexAndRealNumbers numbers)