Area

value class Area : Comparable<Area> (source)

Represents an area, internally stored as a Double of square meters.

Most arithmetic operations are supported, and will automatically result in a scalar, Length, or Area depending on the operation.

Types

Companion

object Companion

Companion object containing predefined area values.

Properties

absoluteValue

val absoluteValue: Area

Returns the absolute value of this area.

inAcres

val Area.inAcres: Double

Returns this Area as a scalar value in acres.

inAres

val Area.inAres: Double

Returns this Area as a scalar value in ares.

inCentiares

val Area.inCentiares: Double

Returns this Area as a scalar value in centiares.

inDecares

val Area.inDecares: Double

Returns this Area as a scalar value in decares.

inDeciares

val Area.inDeciares: Double

Returns this Area as a scalar value in deciares.

inHectares

val Area.inHectares: Double

Returns this Area as a scalar value in hectares.

inSquareCentimeters

val Area.inSquareCentimeters: Double

Returns this Area as a scalar value in square centimeters.

inSquareFeet

val Area.inSquareFeet: Double

Returns this Area as a scalar value in square feet.

inSquareInches

val Area.inSquareInches: Double

Returns this Area as a scalar value in square inches.

inSquareKilometers

val Area.inSquareKilometers: Double

Returns this Area as a scalar value in square kilometers.

inSquareMeters

val Area.inSquareMeters: Double

Returns this Area as a scalar value in square meters.

inSquareMiles

val Area.inSquareMiles: Double

Returns this Area as a scalar value in square miles.

inSquareMillimeters

val Area.inSquareMillimeters: Double

Returns this Area as a scalar value in square millimeters.

inSquareRods

val Area.inSquareRods: Double

Returns this Area as a scalar value in square rods.

inSquareYards

val Area.inSquareYards: Double

Returns this Area as a scalar value in square yards.

isFinite

val isFinite: Boolean

Returns true if this area is finite (not infinite).

isInfinite

val isInfinite: Boolean

Returns true if this area is infinite (positive or negative).

isNegative

val isNegative: Boolean

Returns true if this area is less than zero.

isPositive

val isPositive: Boolean

Returns true if this area is greater than zero.

isZero

val isZero: Boolean

Returns true if this area is equal to zero.

Functions

compareTo

open operator override fun compareTo(other: Area): Int

div

operator fun div(other: Double): Area

Divides this area by a scalar value.

operator fun div(other: Area): Double

Divides this area by another area, resulting in a dimensionless scalar.

operator fun div(other: Length): Length

Divides this Area by a Length, resulting in another Length.

minus

operator fun minus(other: Area): Area

Subtracts another area from this area.

mod

fun mod(other: Area): Area

Returns the modulo of this area with respect to another area.

plus

operator fun plus(other: Area): Area

Adds another area to this area.

rem

operator fun rem(other: Area): Area

Returns the remainder of dividing this area by another area.

roundToInt

fun roundToInt(unit: AreaUnit): Int

Rounds this area to an Int value in the specified unit.

roundToLong

fun roundToLong(unit: AreaUnit): Long

Rounds this area to a Long value in the specified unit.

times

operator fun times(other: Double): Area

Multiplies this area by a scalar value.

toDouble

fun toDouble(unit: AreaUnit): Double

Converts this area to a Double value in the specified unit.

toFloat

fun toFloat(unit: AreaUnit): Float

Converts this area to a Float value in the specified unit.

toString

open override fun toString(): String

Returns a string representation of this area in square meters.

fun toString(unit: AreaUnit = SquareMeters, decimalPlaces: Int = 2): String

Returns a formatted string representation of this area.

unaryMinus

operator fun unaryMinus(): Area

Returns the negation of this area.

unaryPlus

operator fun unaryPlus(): Area

Returns this area unchanged.

Area

See also

Types

Properties

Functions