/// <summary>
/// Multiplies <paramref name="left"/> with <paramref name="right"/>
/// </summary>
/// <param name="left">The left value</param>
/// <param name="right">The right value</param>
/// <returns>The <see cref="LuminousFlux"/> that is the result from the multiplication.</returns>
public static LuminousFlux operator *(SolidAngle left, LuminousIntensity right)
{
return(LuminousFlux.FromLumens(left.steradians * right.candelas));
}
/// <summary>
/// Returns a quantity indicating whether this instance is equal to a specified <see cref="Gu.Units.LuminousFlux"/> object within the given tolerance.
/// </summary>
/// <returns>
/// true if <paramref name="other"/> represents the same LuminousFlux as this instance; otherwise, false.
/// </returns>
/// <param name="other">An instance of <see cref="Gu.Units.LuminousFlux"/> 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(LuminousFlux other, LuminousFlux tolerance)
{
Ensure.GreaterThan(tolerance.lumens, 0, nameof(tolerance));
return(Math.Abs(this.lumens - other.lumens) < tolerance.lumens);
}
/// <summary>
/// Returns a quantity indicating whether this instance is equal to a specified <see cref="Gu.Units.LuminousFlux"/> object.
/// </summary>
/// <returns>
/// true if <paramref name="other"/> represents the same LuminousFlux as this instance; otherwise, false.
/// </returns>
/// <param name="other">An instance of <see cref="Gu.Units.LuminousFlux"/> object to compare with this instance.</param>
public bool Equals(LuminousFlux other)
{
return(this.lumens.Equals(other.lumens));
}
/// <summary>
/// Compares this instance to a specified <see cref="Gu.Units.LuminousFlux"/> 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.LuminousFlux"/> 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.LuminousFlux"/> object to compare to this instance.</param>
public int CompareTo(LuminousFlux quantity)
{
return(this.lumens.CompareTo(quantity.lumens));
}
/// <summary>
/// Creates an instance of <see cref="Gu.Units.LuminousFlux"/> from its string representation
/// </summary>
/// <param name="text">The string representation of the <see cref="Gu.Units.LuminousFlux"/></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="LuminousFlux"/></param>
/// <returns>True if an instance of <see cref="LuminousFlux"/> could be parsed from <paramref name="text"/></returns>
public static bool TryParse(string text, NumberStyles styles, IFormatProvider provider, out LuminousFlux result)
{
return(QuantityParser.TryParse <LuminousFluxUnit, LuminousFlux>(text, From, styles, provider, out result));
}
/// <summary>
/// Creates an instance of <see cref="Gu.Units.LuminousFlux"/> from its string representation
/// </summary>
/// <param name="text">The string representation of the <see cref="Gu.Units.LuminousFlux"/></param>
/// <param name="styles">Specifies the <see cref="NumberStyles"/> to be used.</param>
/// <param name="result">The parsed <see cref="LuminousFlux"/></param>
/// <returns>True if an instance of <see cref="LuminousFlux"/> could be parsed from <paramref name="text"/></returns>
public static bool TryParse(string text, NumberStyles styles, out LuminousFlux result)
{
return(QuantityParser.TryParse <LuminousFluxUnit, LuminousFlux>(text, From, styles, CultureInfo.CurrentCulture, out result));
}
