SizeD (tektosyne API)

java.lang.Object
- org.kynosarges.tektosyne.geometry.SizeD

```
public final class SizeD
extends java.lang.Object
```
Represents an extension in two-dimensional space, using Double coordinates. SizeD contains two immutable non-negative Double extensions. Use SizeI to represent sizes with Integer extensions.

Field Summary

Fields
Modifier and Type	Field and Description
`static SizeD`	`EMPTY` An empty read-only `SizeD`.
`double`	`height` The vertical dimension of the `SizeD`.
`double`	`width` The horizontal dimension of the `SizeD`.

Constructor Summary

Constructors
Constructor and Description

SizeD()
Creates a SizeD with zero extension.

SizeD(double width, double height)
Creates a SizeD with the specified extension.

Constructors
Constructor and Description
`SizeD()` Creates a `SizeD` with zero extension.
`SizeD(double width, double height)` Creates a `SizeD` with the specified extension.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SizeD`	`add(SizeD size)` Adds the extension of the specified `SizeD` to this instance.
`boolean`	`equals(java.lang.Object obj)` Compares the specified `Object` to this `SizeD` instance.
`static boolean`	`equals(SizeD a, SizeD b, double epsilon)` Compares two `SizeD` instances for equality, given the specified epsilon.
`static SizeD[]`	`fromDoubles(double... sizes)` Converts the specified `Double` array to a `SizeD` array.
`int`	`hashCode()` Returns a hash code for the `SizeD`.
`boolean`	`isEmpty()` Determines whether the `SizeD` is empty.
`SizeD`	`restrict(double minWidth, double minHeight, double maxWidth, double maxHeight)` Restricts the `SizeD` to the specified extension range.
`SizeI`	`round()` Converts the `SizeD` to a `SizeI` by rounding dimensions to the nearest `Integer` values.
`SizeD`	`subtract(SizeD size)` Subtracts the extension of the specified `SizeD` from this instance.
`static double[]`	`toDoubles(SizeD... sizes)` Converts the specified `SizeD` array to a `Double` array.
`SizeI`	`toSizeI()` Converts the `SizeD` to a `SizeI` by truncating dimensions to the nearest `Integer` values.
`java.lang.String`	`toString()` Returns a `String` representation of the `SizeD`.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - width
```
public final double width
```
    The horizontal dimension of the SizeD. Never negative.
  - height
```
public final double height
```
    The vertical dimension of the SizeD. Never negative.
  - EMPTY
```
public static final SizeD EMPTY
```
    An empty read-only SizeD. Both width and height are set to zero.
- Constructor Detail
  - SizeD
```
public SizeD()
```
    Creates a SizeD with zero extension. Both width and height are set to zero.
  - SizeD
```
public SizeD(double width,
             double height)
```
    Creates a SizeD with the specified extension.
    
    Parameters:
    
    width - the width of the SizeD.
    
    height - the height of the SizeD.
    
    Throws:
    
    java.lang.IllegalArgumentException - if width or height is less than zero
- Method Detail
  - add
```
public SizeD add(SizeD size)
```
    Adds the extension of the specified SizeD to this instance. Returns Double.POSITIVE_INFINITY in any dimension that overflows Double.
    
    Parameters:
    
    size - the SizeD whose extension to add to this instance
    
    Returns:
    
    a SizeD whose width and height equal the addition of the corresponding dimensions of the specified size to this instance
    
    Throws:
    
    java.lang.NullPointerException - if size is null
  - equals
```
public static boolean equals(SizeD a,
                             SizeD b,
                             double epsilon)
```
    Compares two SizeD instances for equality, given the specified epsilon.
    
    Parameters:
    
    a - the first SizeD to compare
    
    b - the second SizeD to compare
    
    epsilon - the maximum absolute difference where the corresponding dimensions of a and b are considered equal
    
    Returns:
    
    true if the absolute difference between both corresponding dimensions of a and b is no greater than epsilon, else false
    
    Throws:
    
    java.lang.IllegalArgumentException - if epsilon is less than zero
    
    java.lang.NullPointerException - if a or b is null
  - fromDoubles
```
public static SizeD[] fromDoubles(double... sizes)
```
    Converts the specified Double array to a SizeD array. The returned array has half as many elements as the specified sizes and retains the same dimension sequence.
    
    Parameters:
    
    sizes - an array containing the width and height components of SizeD instances, stored in alternating index positions
    
    Returns:
    
    the SizeD array created from sizes
    
    Throws:
    
    java.lang.IllegalArgumentException - if sizes has an odd number of elements, or if any width or height is less than zero
    
    java.lang.NullPointerException - if sizes is null
  - isEmpty
```
public boolean isEmpty()
```
    Determines whether the SizeD is empty.
    
    Returns:
    
    true if both width and height equal zero, else false
  - restrict
```
public SizeD restrict(double minWidth,
                      double minHeight,
                      double maxWidth,
                      double maxHeight)
```
    Restricts the SizeD to the specified extension range.
    
    Parameters:
    
    minWidth - the smallest permissible width
    
    minHeight - the smallest permissible height
    
    maxWidth - the greatest permissible width
    
    maxHeight - the greatest permissible height
    
    Returns:
    
    a SizeD whose width and height equal those of this instance, restricted to the specified extension range
    
    Throws:
    
    java.lang.IllegalArgumentException - if maxWidth or maxHeight is less than zero
  - round
```
public SizeI round()
```
    Converts the SizeD to a SizeI by rounding dimensions to the nearest Integer values. Uses Fortran.nint(double) for rounding.
    
    Returns:
    
    a SizeI whose SizeI.width and SizeI.height equal the corresponding dimensions of the SizeD, rounded to the nearest Integer values
    
    Throws:
    
    java.lang.ArithmeticException - if any dimension overflows Integer
  - subtract
```
public SizeD subtract(SizeD size)
```
    Subtracts the extension of the specified SizeD from this instance.
    
    Parameters:
    
    size - the SizeD extension to subtract from this instance
    
    Returns:
    
    a SizeD whose width and height equal the subtraction of the corresponding dimensions of the specified size from this instance
    
    Throws:
    
    java.lang.IllegalArgumentException - if the difference in any dimension is less than zero
    
    java.lang.NullPointerException - if size is null
  - toDoubles
```
public static double[] toDoubles(SizeD... sizes)
```
    Converts the specified SizeD array to a Double array. The returned array has twice as many elements as the specified sizes and retains the same dimension sequence.
    
    Parameters:
    
    sizes - the SizeD array to convert
    
    Returns:
    
    an array containing the width and height components of all sizes, stored in alternating index positions
    
    Throws:
    
    java.lang.NullPointerException - if sizes or any of its elements is null
  - toSizeI
```
public SizeI toSizeI()
```
    Converts the SizeD to a SizeI by truncating dimensions to the nearest Integer values. Uses Integer casts for truncation.
    
    Returns:
    
    a SizeI whose SizeI.width and SizeI.height equal the corresponding dimensions of the SizeD, truncated to the nearest Integer values
    
    Throws:
    
    java.lang.ArithmeticException - if any dimension overflows Integer
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Compares the specified Object to this SizeD instance.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    obj - the Object to compare to this instance
    
    Returns:
    
    true if obj is not null and a SizeD instance whose width and height equal those of this instance, else false
  - hashCode
```
public int hashCode()
```
    Returns a hash code for the SizeD.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    an Integer hash code for the SizeD
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of the SizeD.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a String containing the values of width and height

Class SizeD

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

width

height

EMPTY

Constructor Detail

SizeD

SizeD

Method Detail

add

equals

fromDoubles

isEmpty

restrict

round

subtract

toDoubles

toSizeI

equals

hashCode

toString