Modifier and Type	Class and Description
public static class	LinearTransformation.LinearTransformationBuilder This is an intermediate stage in the construction process.
private static class	LinearTransformation.NaNLinearTransformation
private static class	LinearTransformation.RegularLinearTransformation
private static class	LinearTransformation.VerticalLinearTransformation

Access	Constructor and Description
public	LinearTransformation()

Method Summary

Modifier and Type	Method and Description
public static LinearTransformation	forNaN() Builds an instance for datasets which contains `Double#NaN`.
public static LinearTransformation	horizontal(double y) Builds an instance representing a horizontal transformation with a constant value of `y`.
public abstract LinearTransformation	inverse() Returns the inverse linear transformation.
public abstract boolean	isHorizontal() Returns whether this is a horizontal transformation.
public abstract boolean	isVertical() Returns whether this is a vertical transformation.
public static LinearTransformation.LinearTransformationBuilder	mapping(double x1, double y1) Start building an instance which maps `x = x1` to `y = y1`.
public abstract double	slope() Returns the slope of the transformation, i.e. the rate of change of `y` with respect to `x`.
public abstract double	transform(double x) Returns the `y` corresponding to the given `x`.
public static LinearTransformation	vertical(double x) Builds an instance representing a vertical transformation with a constant value of `x`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

LinearTransformation	back to summary
public LinearTransformation()

Method Detail

forNaN	back to summary
public static LinearTransformation forNaN() Builds an instance for datasets which contains `Double#NaN`. The `isHorizontal` and `isVertical` methods return `false` and the `slope`, and `transform` methods all return `Double#NaN`. The `inverse` method returns the same instance.

horizontal	back to summary
public static LinearTransformation horizontal(double y) Builds an instance representing a horizontal transformation with a constant value of `y`. (The inverse of this will be a vertical transformation.)

inverse back to summary

inverse	back to summary
public abstract LinearTransformation inverse() Returns the inverse linear transformation. The inverse of a horizontal transformation is a vertical transformation, and vice versa. The inverse of the `forNaN` transformation is itself. In all other cases, the inverse is a transformation such that applying both the original transformation and its inverse to a value gives you the original value give-or-take numerical errors. Calling this method multiple times on the same instance will always return the same instance. Calling this method on the result of calling this method on an instance will always return that original instance.

public abstract LinearTransformation inverse()

Returns the inverse linear transformation. The inverse of a horizontal transformation is a vertical transformation, and vice versa. The inverse of the forNaN transformation is itself. In all other cases, the inverse is a transformation such that applying both the original transformation and its inverse to a value gives you the original value give-or-take numerical errors. Calling this method multiple times on the same instance will always return the same instance. Calling this method on the result of calling this method on an instance will always return that original instance.

isHorizontal	back to summary
public abstract boolean isHorizontal() Returns whether this is a horizontal transformation.

isVertical	back to summary
public abstract boolean isVertical() Returns whether this is a vertical transformation.

mapping	back to summary
public static LinearTransformation.LinearTransformationBuilder mapping(double x1, double y1) Start building an instance which maps `x = x1` to `y = y1`. Both arguments must be finite. Call either `LinearTransformationBuilder#and` or `LinearTransformationBuilder#withSlope` on the returned object to finish building the instance.

slope	back to summary
public abstract double slope() Returns the slope of the transformation, i.e. the rate of change of `y` with respect to `x`. This must not be called on a vertical transformation (i.e. when `isVertical()` is true).

transform	back to summary
public abstract double transform(double x) Returns the `y` corresponding to the given `x`. This must not be called on a vertical transformation (i.e. when `isVertical()` is true).

vertical	back to summary
public static LinearTransformation vertical(double x) Builds an instance representing a vertical transformation with a constant value of `x`. (The inverse of this will be a horizontal transformation.)

com.google.common.math back to summary

public final Class LinearTransformation.LinearTransformationBuilder

Class Inheritance

extends Object

java.lang.Object
com.google.common.math.LinearTransformation.LinearTransformationBuilder

This is an intermediate stage in the construction process. It is returned by LinearTransformation#mapping. You almost certainly don't want to keep instances around, but instead use method chaining. This represents a single point mapping, i.e. a mapping between one x and y value pair.

Since: 20.0

Field Summary

Modifier and Type	Field and Description
private final double	x1
private final double	y1

Constructor Summary

Access	Constructor and Description
private	LinearTransformationBuilder(double x1, double y1)

Method Summary

Modifier and Type	Method and Description
public LinearTransformation	and(double x2, double y2) Finish building an instance which also maps `x = x2` to `y = y2`.
public LinearTransformation	withSlope(double slope) Finish building an instance with the given slope, i.e. the rate of change of `y` with respect to `x`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

x1	back to summary
private final double x1

y1	back to summary
private final double y1

Constructor Detail

LinearTransformationBuilder	back to summary
private LinearTransformationBuilder(double x1, double y1)

Method Detail

and	back to summary
public LinearTransformation and(double x2, double y2) Finish building an instance which also maps `x = x2` to `y = y2`. These values must not both be identical to the values given in the first mapping. If only the `x` values are identical, the transformation is vertical. If only the `y` values are identical, the transformation is horizontal (i.e. the slope is zero).

withSlope	back to summary
public LinearTransformation withSlope(double slope) Finish building an instance with the given slope, i.e. the rate of change of `y` with respect to `x`. The slope must not be `NaN`. It may be infinite, in which case the transformation is vertical. (If it is zero, the transformation is horizontal.)

com.google.common.math back to summary

private final Class LinearTransformation.NaNLinearTransformation

Class Inheritance

extends LinearTransformation

java.lang.Object
com.google.common.math.LinearTransformation
com.google.common.math.LinearTransformation.NaNLinearTransformation

Field Summary

Modifier and Type	Field and Description
pack-priv static final LinearTransformation.NaNLinearTransformation	INSTANCE

Constructor Summary

Access	Constructor and Description
private	NaNLinearTransformation()

Method Summary

Modifier and Type	Method and Description
public LinearTransformation	inverse() Implements abstract com.google.common.math.LinearTransformation.inverse. Returns the inverse linear transformation.
public boolean	isHorizontal() Implements abstract com.google.common.math.LinearTransformation.isHorizontal. Returns whether this is a horizontal transformation.
public boolean	isVertical() Implements abstract com.google.common.math.LinearTransformation.isVertical. Returns whether this is a vertical transformation.
public double	slope() Implements abstract com.google.common.math.LinearTransformation.slope. Returns the slope of the transformation, i.e. the rate of change of `y` with respect to `x`.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public double	transform(double x) Implements abstract com.google.common.math.LinearTransformation.transform. Returns the `y` corresponding to the given `x`.

Inherited from com.google.common.math.LinearTransformation:: forNaN horizontal mapping vertical

Field Detail

INSTANCE	back to summary
pack-priv static final LinearTransformation.NaNLinearTransformation INSTANCE

Constructor Detail

NaNLinearTransformation	back to summary
private NaNLinearTransformation()

Method Detail

inverse back to summary

inverse	back to summary
public LinearTransformation inverse() Implements abstract com.google.common.math.LinearTransformation.inverse. Doc from com.google.common.math.LinearTransformation.inverse. Returns the inverse linear transformation. The inverse of a horizontal transformation is a vertical transformation, and vice versa. The inverse of the `forNaN` transformation is itself. In all other cases, the inverse is a transformation such that applying both the original transformation and its inverse to a value gives you the original value give-or-take numerical errors. Calling this method multiple times on the same instance will always return the same instance. Calling this method on the result of calling this method on an instance will always return that original instance. Annotations @Override

public LinearTransformation inverse()

Implements abstract com.google.common.math.LinearTransformation.inverse.

Doc from com.google.common.math.LinearTransformation.inverse.

Annotations

@Override

isHorizontal	back to summary
public boolean isHorizontal() Implements abstract com.google.common.math.LinearTransformation.isHorizontal. Doc from com.google.common.math.LinearTransformation.isHorizontal. Returns whether this is a horizontal transformation. Annotations @Override

isHorizontal

back to summary

public boolean isHorizontal()

Implements abstract com.google.common.math.LinearTransformation.isHorizontal.

Doc from com.google.common.math.LinearTransformation.isHorizontal.

Returns whether this is a horizontal transformation.

Annotations

@Override

isVertical	back to summary
public boolean isVertical() Implements abstract com.google.common.math.LinearTransformation.isVertical. Doc from com.google.common.math.LinearTransformation.isVertical. Returns whether this is a vertical transformation. Annotations @Override

isVertical

back to summary

public boolean isVertical()

Implements abstract com.google.common.math.LinearTransformation.isVertical.

Doc from com.google.common.math.LinearTransformation.isVertical.

Returns whether this is a vertical transformation.

Annotations

@Override

slope back to summary

slope	back to summary
public double slope() Implements abstract com.google.common.math.LinearTransformation.slope. Doc from com.google.common.math.LinearTransformation.slope. Returns the slope of the transformation, i.e. the rate of change of `y` with respect to `x`. This must not be called on a vertical transformation (i.e. when `isVertical()` is true). Annotations @Override

public double slope()

Implements abstract com.google.common.math.LinearTransformation.slope.

Doc from com.google.common.math.LinearTransformation.slope.

Returns the slope of the transformation, i.e. the rate of change of y with respect to x. This must not be called on a vertical transformation (i.e. when isVertical() is true).

Annotations

@Override

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

transform back to summary

transform	back to summary
public double transform(double x) Implements abstract com.google.common.math.LinearTransformation.transform. Doc from com.google.common.math.LinearTransformation.transform. Returns the `y` corresponding to the given `x`. This must not be called on a vertical transformation (i.e. when `isVertical()` is true). Annotations @Override

public double transform(double x)

Implements abstract com.google.common.math.LinearTransformation.transform.

Doc from com.google.common.math.LinearTransformation.transform.

Returns the y corresponding to the given x. This must not be called on a vertical transformation (i.e. when isVertical() is true).

Annotations

@Override

com.google.common.math back to summary

private final Class LinearTransformation.RegularLinearTransformation

Class Inheritance

extends LinearTransformation

java.lang.Object
com.google.common.math.LinearTransformation
com.google.common.math.LinearTransformation.RegularLinearTransformation

Field Summary

Modifier and Type	Field and Description
pack-priv LinearTransformation	inverse
pack-priv final double	slope
pack-priv final double	yIntercept

Constructor Summary

Access	Constructor and Description
pack-priv	RegularLinearTransformation(double slope, double yIntercept)
pack-priv	RegularLinearTransformation(double slope, double yIntercept, LinearTransformation inverse)

Method Summary

Modifier and Type	Method and Description
private LinearTransformation	createInverse()
public LinearTransformation	inverse() Implements abstract com.google.common.math.LinearTransformation.inverse. Returns the inverse linear transformation.
public boolean	isHorizontal() Implements abstract com.google.common.math.LinearTransformation.isHorizontal. Returns whether this is a horizontal transformation.
public boolean	isVertical() Implements abstract com.google.common.math.LinearTransformation.isVertical. Returns whether this is a vertical transformation.
public double	slope() Implements abstract com.google.common.math.LinearTransformation.slope. Returns the slope of the transformation, i.e. the rate of change of `y` with respect to `x`.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public double	transform(double x) Implements abstract com.google.common.math.LinearTransformation.transform. Returns the `y` corresponding to the given `x`.

Inherited from com.google.common.math.LinearTransformation:: forNaN horizontal mapping vertical

Field Detail

inverse	back to summary
pack-priv LinearTransformation inverse Annotations @CheckForNull @LazyInit

slope	back to summary
pack-priv final double slope

yIntercept	back to summary
pack-priv final double yIntercept

Constructor Detail

RegularLinearTransformation	back to summary
pack-priv RegularLinearTransformation(double slope, double yIntercept)

RegularLinearTransformation	back to summary
pack-priv RegularLinearTransformation(double slope, double yIntercept, LinearTransformation inverse)

Method Detail

createInverse	back to summary
private LinearTransformation createInverse()

inverse back to summary

inverse	back to summary
public LinearTransformation inverse() Implements abstract com.google.common.math.LinearTransformation.inverse. Doc from com.google.common.math.LinearTransformation.inverse. Returns the inverse linear transformation. The inverse of a horizontal transformation is a vertical transformation, and vice versa. The inverse of the `forNaN` transformation is itself. In all other cases, the inverse is a transformation such that applying both the original transformation and its inverse to a value gives you the original value give-or-take numerical errors. Calling this method multiple times on the same instance will always return the same instance. Calling this method on the result of calling this method on an instance will always return that original instance. Annotations @Override

public LinearTransformation inverse()

Implements abstract com.google.common.math.LinearTransformation.inverse.

Doc from com.google.common.math.LinearTransformation.inverse.

Annotations

@Override

isHorizontal	back to summary
public boolean isHorizontal() Implements abstract com.google.common.math.LinearTransformation.isHorizontal. Doc from com.google.common.math.LinearTransformation.isHorizontal. Returns whether this is a horizontal transformation. Annotations @Override

isHorizontal

back to summary

public boolean isHorizontal()

Implements abstract com.google.common.math.LinearTransformation.isHorizontal.

Doc from com.google.common.math.LinearTransformation.isHorizontal.

Returns whether this is a horizontal transformation.

Annotations

@Override

isVertical	back to summary
public boolean isVertical() Implements abstract com.google.common.math.LinearTransformation.isVertical. Doc from com.google.common.math.LinearTransformation.isVertical. Returns whether this is a vertical transformation. Annotations @Override

isVertical

back to summary

public boolean isVertical()

Implements abstract com.google.common.math.LinearTransformation.isVertical.

Doc from com.google.common.math.LinearTransformation.isVertical.

Returns whether this is a vertical transformation.

Annotations

@Override

slope back to summary

slope	back to summary
public double slope() Implements abstract com.google.common.math.LinearTransformation.slope. Doc from com.google.common.math.LinearTransformation.slope. Returns the slope of the transformation, i.e. the rate of change of `y` with respect to `x`. This must not be called on a vertical transformation (i.e. when `isVertical()` is true). Annotations @Override

public double slope()

Implements abstract com.google.common.math.LinearTransformation.slope.

Doc from com.google.common.math.LinearTransformation.slope.

Returns the slope of the transformation, i.e. the rate of change of y with respect to x. This must not be called on a vertical transformation (i.e. when isVertical() is true).

Annotations

@Override

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

transform back to summary

transform	back to summary
public double transform(double x) Implements abstract com.google.common.math.LinearTransformation.transform. Doc from com.google.common.math.LinearTransformation.transform. Returns the `y` corresponding to the given `x`. This must not be called on a vertical transformation (i.e. when `isVertical()` is true). Annotations @Override

public double transform(double x)

Implements abstract com.google.common.math.LinearTransformation.transform.

Doc from com.google.common.math.LinearTransformation.transform.

Returns the y corresponding to the given x. This must not be called on a vertical transformation (i.e. when isVertical() is true).

Annotations

@Override

com.google.common.math back to summary

private final Class LinearTransformation.VerticalLinearTransformation

Class Inheritance

extends LinearTransformation

java.lang.Object
com.google.common.math.LinearTransformation
com.google.common.math.LinearTransformation.VerticalLinearTransformation

Field Summary

Modifier and Type	Field and Description
pack-priv LinearTransformation	inverse
pack-priv final double	x

Constructor Summary

Access	Constructor and Description
pack-priv	VerticalLinearTransformation(double x)
pack-priv	VerticalLinearTransformation(double x, LinearTransformation inverse)

Method Summary

Modifier and Type	Method and Description
private LinearTransformation	createInverse()
public LinearTransformation	inverse() Implements abstract com.google.common.math.LinearTransformation.inverse. Returns the inverse linear transformation.
public boolean	isHorizontal() Implements abstract com.google.common.math.LinearTransformation.isHorizontal. Returns whether this is a horizontal transformation.
public boolean	isVertical() Implements abstract com.google.common.math.LinearTransformation.isVertical. Returns whether this is a vertical transformation.
public double	slope() Implements abstract com.google.common.math.LinearTransformation.slope. Returns the slope of the transformation, i.e. the rate of change of `y` with respect to `x`.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public double	transform(double x) Implements abstract com.google.common.math.LinearTransformation.transform. Returns the `y` corresponding to the given `x`.

Inherited from com.google.common.math.LinearTransformation:: forNaN horizontal mapping vertical

Field Detail

inverse	back to summary
pack-priv LinearTransformation inverse Annotations @CheckForNull @LazyInit

x	back to summary
pack-priv final double x

Constructor Detail

VerticalLinearTransformation	back to summary
pack-priv VerticalLinearTransformation(double x)

VerticalLinearTransformation	back to summary
pack-priv VerticalLinearTransformation(double x, LinearTransformation inverse)

Method Detail

createInverse	back to summary
private LinearTransformation createInverse()

inverse back to summary

public LinearTransformation inverse()

Implements abstract com.google.common.math.LinearTransformation.inverse.

Doc from com.google.common.math.LinearTransformation.inverse.

Annotations

@Override

isHorizontal

back to summary

public boolean isHorizontal()

Implements abstract com.google.common.math.LinearTransformation.isHorizontal.

Doc from com.google.common.math.LinearTransformation.isHorizontal.

Returns whether this is a horizontal transformation.

Annotations

@Override

isVertical

back to summary

public boolean isVertical()

Implements abstract com.google.common.math.LinearTransformation.isVertical.

Doc from com.google.common.math.LinearTransformation.isVertical.

Returns whether this is a vertical transformation.

Annotations

@Override

slope back to summary

public double slope()

Implements abstract com.google.common.math.LinearTransformation.slope.

Doc from com.google.common.math.LinearTransformation.slope.

Returns the slope of the transformation, i.e. the rate of change of y with respect to x. This must not be called on a vertical transformation (i.e. when isVertical() is true).

Annotations

@Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

transform back to summary

public double transform(double x)

Implements abstract com.google.common.math.LinearTransformation.transform.

Doc from com.google.common.math.LinearTransformation.transform.

Returns the y corresponding to the given x. This must not be called on a vertical transformation (i.e. when isVertical() is true).

Annotations

@Override

public abstract Class LinearTransformation

Nested and Inner Type Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public final Class LinearTransformation.LinearTransformationBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class LinearTransformation.NaNLinearTransformation

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class LinearTransformation.RegularLinearTransformation

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class LinearTransformation.VerticalLinearTransformation

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail