/// <summary>
/// Divides <paramref name="left"/> by <paramref name="right"/>
/// </summary>
/// <param name="left">The left value</param>
/// <param name="right">The right value</param>
/// <returns>The <see cref="Illuminance"/> that is the result from the division.</returns>
public static Illuminance operator /(LuminousFlux left, Area right)
{
return(Illuminance.FromLux(left.lumens / right.squareMetres));
}
/// <summary>
/// Returns a quantity indicating whether this instance is equal to a specified <see cref="Gu.Units.Illuminance"/> object within the given tolerance.
/// </summary>
/// <returns>
/// true if <paramref name="other"/> represents the same Illuminance as this instance; otherwise, false.
/// </returns>
/// <param name="other">An instance of <see cref="Gu.Units.Illuminance"/> object to compare with this instance.</param>
/// <param name="tolerance">The maximum difference for being considered equal. Must be greater than zero.</param>
public bool Equals(Illuminance other, Illuminance tolerance)
{
Ensure.GreaterThan(tolerance.lux, 0, nameof(tolerance));
return(Math.Abs(this.lux - other.lux) < tolerance.lux);
}
/// <summary>
/// Returns a quantity indicating whether this instance is equal to a specified <see cref="Gu.Units.Illuminance"/> object.
/// </summary>
/// <returns>
/// true if <paramref name="other"/> represents the same Illuminance as this instance; otherwise, false.
/// </returns>
/// <param name="other">An instance of <see cref="Gu.Units.Illuminance"/> object to compare with this instance.</param>
public bool Equals(Illuminance other)
{
return(this.lux.Equals(other.lux));
}
/// <summary>
/// Compares this instance to a specified <see cref="Gu.Units.Illuminance"/> object and returns an integer that indicates whether this <paramref name="quantity"/> is smaller than, equal to, or greater than the <see cref="Gu.Units.Illuminance"/> object.
/// </summary>
/// <returns>
/// A signed number indicating the relative quantitys of this instance and <paramref name="quantity"/>.
///
/// Value
///
/// Description
///
/// A negative integer
///
/// This instance is smaller than <paramref name="quantity"/>.
///
/// Zero
///
/// This instance is equal to <paramref name="quantity"/>.
///
/// A positive integer
///
/// This instance is larger than <paramref name="quantity"/>.
///
/// </returns>
/// <param name="quantity">An instance of <see cref="Gu.Units.Illuminance"/> object to compare to this instance.</param>
public int CompareTo(Illuminance quantity)
{
return(this.lux.CompareTo(quantity.lux));
}
/// <summary>
/// Creates an instance of <see cref="Gu.Units.Illuminance"/> from its string representation
/// </summary>
/// <param name="text">The string representation of the <see cref="Gu.Units.Illuminance"/></param>
/// <param name="styles">Specifies the <see cref="NumberStyles"/> to be used.</param>
/// <param name="provider">Specifies the formatProvider to be used.</param>
/// <param name="result">The parsed <see cref="Illuminance"/></param>
/// <returns>True if an instance of <see cref="Illuminance"/> could be parsed from <paramref name="text"/></returns>
public static bool TryParse(string text, NumberStyles styles, IFormatProvider provider, out Illuminance result)
{
return(QuantityParser.TryParse <IlluminanceUnit, Illuminance>(text, From, styles, provider, out result));
}
/// <summary>
/// Creates an instance of <see cref="Gu.Units.Illuminance"/> from its string representation
/// </summary>
/// <param name="text">The string representation of the <see cref="Gu.Units.Illuminance"/></param>
/// <param name="styles">Specifies the <see cref="NumberStyles"/> to be used.</param>
/// <param name="result">The parsed <see cref="Illuminance"/></param>
/// <returns>True if an instance of <see cref="Illuminance"/> could be parsed from <paramref name="text"/></returns>
public static bool TryParse(string text, NumberStyles styles, out Illuminance result)
{
return(QuantityParser.TryParse <IlluminanceUnit, Illuminance>(text, From, styles, CultureInfo.CurrentCulture, out result));
}
