//****************************************************************************************************** // Angle.cs - Gbtc // // Copyright © 2012, Grid Protection Alliance. All Rights Reserved. // // Licensed to the Grid Protection Alliance (GPA) under one or more contributor license agreements. See // the NOTICE file distributed with this work for additional information regarding copyright ownership. // The GPA licenses this file to you under the MIT License (MIT), the "License"; you may // not use this file except in compliance with the License. You may obtain a copy of the License at: // // http://www.opensource.org/licenses/MIT // // Unless agreed to in writing, the subject software distributed under the License is distributed on an // "AS-IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. Refer to the // License for the specific language governing permissions and limitations. // // Code Modification History: // ---------------------------------------------------------------------------------------------------- // 01/25/2008 - J. Ritchie Carroll // Initial version of source generated. // 09/11/2008 - J. Ritchie Carroll // Converted to C#. // 08/10/2009 - Josh L. Patterson // Edited Comments. // 09/14/2009 - Stephen C. Wills // Added new header and license agreement. // 12/14/2012 - Starlynn Danyelle Gilliam // Modified Header. // 10/03/2017 - J. Ritchie Carroll // Added units enumeration with associated Convert method. // //****************************************************************************************************** #region [ Contributor License Agreements ] /**************************************************************************\ Copyright © 2009 - J. Ritchie Carroll All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \**************************************************************************/ #endregion using System; using System.Collections.Generic; using System.ComponentModel; using System.Globalization; using System.Linq; using System.Runtime.CompilerServices; using GSF.NumericalAnalysis; namespace GSF.Units { #region [ Enumerations ] /// /// Represents the units available for an value. /// public enum AngleUnit { /// /// Radian angle units. /// Radians, /// /// Degree angle units. /// Degrees, /// /// Grad angle units, a.k.a., grade, gradian and gon. /// Grads, /// /// ArcMinute angle units, a.k.a., minute of arc or MOA. /// ArcMinutes, /// /// ArcSecond angle units, a.k.a., second of arc. /// ArcSeconds, /// /// AngularMil angle units, a.k.a., mil. /// AngularMil } #endregion /// /// Represents an angle, in radians, as a double-precision floating-point number. /// /// /// This class behaves just like a representing an angle in radians; it is implicitly /// castable to and from a and therefore can be generally used "as" a double, but it /// has the advantage of handling conversions to and from other angle representations, specifically /// degrees, grads (a.k.a., grade, gradian and gon), arcminutes (a.k.a., minute of arc or MOA), /// arcseconds (a.k.a., second of arc) and angular mil (a.k.a., mil). /// /// This example converts degrees to grads: /// /// public double GetGrads(double degrees) /// { /// return Angle.FromDegrees(degrees).ToGrads(); /// } /// /// /// [Serializable] public struct Angle : IComparable, IFormattable, IConvertible, IComparable, IComparable, IEquatable, IEquatable { #region [ Members ] // Constants private const double DegreesFactor = Math.PI / 180.0D; private const double GradsFactor = Math.PI / 200.0D; private const double ArcMinutesFactor = Math.PI / 180.0D / 60.0D; private const double ArcSecondsFactor = Math.PI / 180.0D / 3600.0D; private const double AngularMilFactor = 2.0D * Math.PI / 6400.0D; private const double TwoPI = 2.0D * Math.PI; // Fields private readonly double m_value; // Angle value stored in radians #endregion #region [ Constructors ] /// /// Creates a new . /// /// New angle value in radians. public Angle(double value) { m_value = value; } #endregion #region [ Methods ] /// /// Gets the value in degrees. /// /// Value of in degrees. public double ToDegrees() { return m_value / DegreesFactor; } /// /// Gets the value in grads. /// /// Value of in grads. public double ToGrads() { return m_value / GradsFactor; } /// /// Gets the value in arcminutes. /// /// Value of in arcminutes. public double ToArcMinutes() { return m_value / ArcMinutesFactor; } /// /// Gets the value in arcseconds. /// /// Value of in arcseconds. public double ToArcSeconds() { return m_value / ArcSecondsFactor; } /// /// Gets the value in angular mil. /// /// Value of in angular mil. public double ToAngularMil() { return m_value / AngularMilFactor; } /// /// Converts the to the specified . /// /// Target units. /// converted to . public double ConvertTo(AngleUnit targetUnit) { switch (targetUnit) { case AngleUnit.Radians: return m_value; case AngleUnit.Degrees: return ToDegrees(); case AngleUnit.Grads: return ToGrads(); case AngleUnit.ArcMinutes: return ToArcMinutes(); case AngleUnit.ArcSeconds: return ToArcSeconds(); case AngleUnit.AngularMil: return ToAngularMil(); default: throw new ArgumentOutOfRangeException(nameof(targetUnit), targetUnit, null); } } /// /// Gets the equivalent angle moved within the range of /// and + 2.0 * . /// /// The minimum value of the range. /// Indicates whether the range is inclusive of the minimum value. /// The equivalent angle within the specified range. public Angle ToRange(Angle minValue, bool inclusive = true) { return inclusive ? Euclidean.Wrap(this, minValue, TwoPI) : Euclidean.Wrap(this, minValue + TwoPI, -TwoPI); } #region [ Numeric Interface Implementations ] /// /// Compares this instance to a specified object and returns an indication of their relative values. /// /// An object to compare, or null. /// /// A signed number indicating the relative values of this instance and value. Returns less than zero /// if this instance is less than value, zero if this instance is equal to value, or greater than zero /// if this instance is greater than value. /// /// value is not a or . public int CompareTo(object value) { if (value == null) return 1; if (!(value is double) && !(value is Angle)) throw new ArgumentException("Argument must be a Double or an Angle"); double num = (double)value; return m_value < num ? -1 : (m_value > num ? 1 : 0); } /// /// Compares this instance to a specified and returns an indication of their /// relative values. /// /// An to compare. /// /// A signed number indicating the relative values of this instance and value. Returns less than zero /// if this instance is less than value, zero if this instance is equal to value, or greater than zero /// if this instance is greater than value. /// public int CompareTo(Angle value) { return CompareTo((double)value); } /// /// Compares this instance to a specified and returns an indication of their /// relative values. /// /// A to compare. /// /// A signed number indicating the relative values of this instance and value. Returns less than zero /// if this instance is less than value, zero if this instance is equal to value, or greater than zero /// if this instance is greater than value. /// public int CompareTo(double value) { return m_value < value ? -1 : (m_value > value ? 1 : 0); } /// /// Returns a value indicating whether this instance is equal to a specified object. /// /// An object to compare, or null. /// /// True if obj is an instance of or and equals the value of this instance; /// otherwise, False. /// public override bool Equals(object obj) { if (obj is double) return Equals((double)obj); if (obj is Angle) return Equals((Angle)obj); return false; } /// /// Returns a value indicating whether this instance is equal to a specified value. /// /// An value to compare to this instance. /// /// True if obj has the same value as this instance; otherwise, False. /// public bool Equals(Angle obj) { return Equals((double)obj); } /// /// Returns a value indicating whether this instance is equal to a specified value. /// /// A value to compare to this instance. /// /// True if obj has the same value as this instance; otherwise, False. /// public bool Equals(double obj) { return m_value == obj; } /// /// Returns the hash code for this instance. /// /// /// A 32-bit signed integer hash code. /// public override int GetHashCode() { return m_value.GetHashCode(); } /// /// Converts the numeric value of this instance to its equivalent string representation. /// /// /// The string representation of the value of this instance, consisting of a minus sign if /// the value is negative, and a sequence of digits ranging from 0 to 9 with no leading zeros. /// public override string ToString() { return m_value.ToString(); } /// /// Converts the numeric value of this instance to its equivalent string representation, using /// the specified format. /// /// A format string. /// /// The string representation of the value of this instance as specified by format. /// public string ToString(string format) { return m_value.ToString(format); } /// /// Converts the numeric value of this instance to its equivalent string representation using the /// specified culture-specific format information. /// /// /// A that supplies culture-specific formatting information. /// /// /// The string representation of the value of this instance as specified by provider. /// public string ToString(IFormatProvider provider) { return m_value.ToString(provider); } /// /// Converts the numeric value of this instance to its equivalent string representation using the /// specified format and culture-specific format information. /// /// A format specification. /// /// A that supplies culture-specific formatting information. /// /// /// The string representation of the value of this instance as specified by format and provider. /// public string ToString(string format, IFormatProvider provider) { return m_value.ToString(format, provider); } /// /// Converts the string representation of a number to its equivalent. /// /// A string containing a number to convert. /// /// An equivalent to the number contained in s. /// /// s is null. /// /// s represents a number less than or greater than . /// /// s is not in the correct format. public static Angle Parse(string s) { return double.Parse(s); } /// /// Converts the string representation of a number in a specified style to its equivalent. /// /// A string containing a number to convert. /// /// A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s. /// /// /// An equivalent to the number contained in s. /// /// /// style is not a System.Globalization.NumberStyles value. -or- style is not a combination of /// System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values. /// /// s is null. /// /// s represents a number less than or greater than . /// /// s is not in a format compliant with style. public static Angle Parse(string s, NumberStyles style) { return double.Parse(s, style); } /// /// Converts the string representation of a number in a specified culture-specific format to its equivalent. /// /// A string containing a number to convert. /// /// A that supplies culture-specific formatting information about s. /// /// /// An equivalent to the number contained in s. /// /// s is null. /// /// s represents a number less than or greater than . /// /// s is not in the correct format. public static Angle Parse(string s, IFormatProvider provider) { return double.Parse(s, provider); } /// /// Converts the string representation of a number in a specified style and culture-specific format to its equivalent. /// /// A string containing a number to convert. /// /// A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s. /// /// /// A that supplies culture-specific formatting information about s. /// /// /// An equivalent to the number contained in s. /// /// /// style is not a System.Globalization.NumberStyles value. -or- style is not a combination of /// System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values. /// /// s is null. /// /// s represents a number less than or greater than . /// /// s is not in a format compliant with style. public static Angle Parse(string s, NumberStyles style, IFormatProvider provider) { return double.Parse(s, style, provider); } /// /// Converts the string representation of a number to its equivalent. A return value /// indicates whether the conversion succeeded or failed. /// /// A string containing a number to convert. /// /// When this method returns, contains the value equivalent to the number contained in s, /// if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null, /// is not of the correct format, or represents a number less than or greater than . /// This parameter is passed uninitialized. /// /// true if s was converted successfully; otherwise, false. public static bool TryParse(string s, out Angle result) { double parseResult; bool parseResponse; parseResponse = double.TryParse(s, out parseResult); result = parseResult; return parseResponse; } /// /// Converts the string representation of a number in a specified style and culture-specific format to its /// equivalent. A return value indicates whether the conversion succeeded or failed. /// /// A string containing a number to convert. /// /// A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s. /// /// /// When this method returns, contains the value equivalent to the number contained in s, /// if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null, /// is not in a format compliant with style, or represents a number less than or /// greater than . This parameter is passed uninitialized. /// /// /// A object that supplies culture-specific formatting information about s. /// /// true if s was converted successfully; otherwise, false. /// /// style is not a System.Globalization.NumberStyles value. -or- style is not a combination of /// System.Globalization.NumberStyles.AllowHexSpecifier and System.Globalization.NumberStyles.HexNumber values. /// public static bool TryParse(string s, NumberStyles style, IFormatProvider provider, out Angle result) { double parseResult; bool parseResponse; parseResponse = double.TryParse(s, style, provider, out parseResult); result = parseResult; return parseResponse; } /// /// Returns the for value type . /// /// The enumerated constant, . public TypeCode GetTypeCode() { return TypeCode.Double; } #region [ Explicit IConvertible Implementation ] // These are explicitly implemented on the native System.Double implementations, so we do the same... bool IConvertible.ToBoolean(IFormatProvider provider) { return Convert.ToBoolean(m_value, provider); } char IConvertible.ToChar(IFormatProvider provider) { return Convert.ToChar(m_value, provider); } sbyte IConvertible.ToSByte(IFormatProvider provider) { return Convert.ToSByte(m_value, provider); } byte IConvertible.ToByte(IFormatProvider provider) { return Convert.ToByte(m_value, provider); } short IConvertible.ToInt16(IFormatProvider provider) { return Convert.ToInt16(m_value, provider); } ushort IConvertible.ToUInt16(IFormatProvider provider) { return Convert.ToUInt16(m_value, provider); } int IConvertible.ToInt32(IFormatProvider provider) { return Convert.ToInt32(m_value, provider); } uint IConvertible.ToUInt32(IFormatProvider provider) { return Convert.ToUInt32(m_value, provider); } long IConvertible.ToInt64(IFormatProvider provider) { return Convert.ToInt64(m_value, provider); } ulong IConvertible.ToUInt64(IFormatProvider provider) { return Convert.ToUInt64(m_value, provider); } float IConvertible.ToSingle(IFormatProvider provider) { return Convert.ToSingle(m_value, provider); } double IConvertible.ToDouble(IFormatProvider provider) { return m_value; } decimal IConvertible.ToDecimal(IFormatProvider provider) { return Convert.ToDecimal(m_value, provider); } DateTime IConvertible.ToDateTime(IFormatProvider provider) { return Convert.ToDateTime(m_value, provider); } object IConvertible.ToType(Type type, IFormatProvider provider) { return Convert.ChangeType(m_value, type, provider) ?? Activator.CreateInstance(type); } #endregion #endregion #endregion #region [ Operators ] #region [ Comparison Operators ] /// /// Compares the two values for equality. /// /// An as the left hand operand. /// An as the right hand operand. /// A as the operation result. public static bool operator ==(Angle value1, Angle value2) { return value1.Equals(value2); } /// /// Compares the two values for inequality. /// /// An as the left hand operand. /// An as the right hand operand. /// A as the operation result. public static bool operator !=(Angle value1, Angle value2) { return !value1.Equals(value2); } /// /// Returns true if left value is less than right value. /// /// An as the left hand operand. /// An as the right hand operand. /// A as the operation result. public static bool operator <(Angle value1, Angle value2) { return value1.CompareTo(value2) < 0; } /// /// Returns true if left value is less or equal to than right value. /// /// An as the left hand operand. /// An as the right hand operand. /// A as the operation result. public static bool operator <=(Angle value1, Angle value2) { return value1.CompareTo(value2) <= 0; } /// /// Returns true if left value is greater than right value. /// /// An as the left hand operand. /// An as the right hand operand. /// A as the operation result. public static bool operator >(Angle value1, Angle value2) { return value1.CompareTo(value2) > 0; } /// /// Returns true if left value is greater than or equal to right value. /// /// An as the left hand operand. /// An as the right hand operand. /// A as the operation result. public static bool operator >=(Angle value1, Angle value2) { return value1.CompareTo(value2) >= 0; } #endregion #region [ Type Conversion Operators ] /// /// Implicitly converts value, represented in radians, to an . /// /// A value. /// An object. public static implicit operator Angle(double value) { return new Angle(value); } /// /// Implicitly converts , represented in radians, to a . /// /// An object. /// A value. public static implicit operator double(Angle value) { return value.m_value; } #endregion #region [ Arithmetic Operators ] /// /// Returns computed remainder after dividing first value by the second. /// /// An as the left hand operand. /// An as the right hand operand. /// An as the result. public static Angle operator %(Angle value1, Angle value2) { return value1.m_value % value2.m_value; } /// /// Returns computed sum of values. /// /// An as the left hand operand. /// An as the right hand operand. /// An as the result. public static Angle operator +(Angle value1, Angle value2) { return value1.m_value + value2.m_value; } /// /// Returns computed difference of values. /// /// An as the left hand operand. /// An as the right hand operand. /// An as the result. public static Angle operator -(Angle value1, Angle value2) { return value1.m_value - value2.m_value; } /// /// Returns computed product of values. /// /// An as the left hand operand. /// An as the right hand operand. /// An as the result. public static Angle operator *(Angle value1, Angle value2) { return value1.m_value * value2.m_value; } /// /// Returns computed division of values. /// /// An as the left hand operand. /// An as the right hand operand. /// An as the result. public static Angle operator /(Angle value1, Angle value2) { return value1.m_value / value2.m_value; } // C# doesn't expose an exponent operator but some other .NET languages do, // so we expose the operator via its native special IL function name /// /// Returns result of first value raised to power of second value. /// /// An as the left hand operand. /// An as the right hand operand. /// A as the result. [EditorBrowsable(EditorBrowsableState.Advanced), SpecialName] public static double op_Exponent(Angle value1, Angle value2) { return Math.Pow(value1.m_value, value2.m_value); } #endregion #endregion #region [ Static ] // Static Fields /// Represents the largest possible value of an . This field is constant. public static readonly Angle MaxValue = double.MaxValue; /// Represents the smallest possible value of an . This field is constant. public static readonly Angle MinValue = double.MinValue; // Static Methods /// /// Creates a new value from the specified in degrees. /// /// New value in degrees. /// New object from the specified in degrees. public static Angle FromDegrees(double value) { return new Angle(value * DegreesFactor); } /// /// Creates a new value from the specified in grads. /// /// New value in grads. /// New object from the specified in grads. public static Angle FromGrads(double value) { return new Angle(value * GradsFactor); } /// /// Creates a new value from the specified in arcminutes. /// /// New value in arcminutes. /// New object from the specified in arcminutes. public static Angle FromArcMinutes(double value) { return new Angle(value * ArcMinutesFactor); } /// /// Creates a new value from the specified in arcseconds. /// /// New value in arcseconds. /// New object from the specified in arcseconds. public static Angle FromArcSeconds(double value) { return new Angle(value * ArcSecondsFactor); } /// /// Creates a new value from the specified in angular mil. /// /// New value in angular mil. /// New object from the specified in angular mil. public static Angle FromAngularMil(double value) { return new Angle(value * AngularMilFactor); } /// /// Converts the in the specified to a new in radians. /// /// Source value. /// Source value units. /// New from the specified in . public static Angle ConvertFrom(double value, AngleUnit sourceUnit) { switch (sourceUnit) { case AngleUnit.Radians: return value; case AngleUnit.Degrees: return FromDegrees(value); case AngleUnit.Grads: return FromGrads(value); case AngleUnit.ArcMinutes: return FromArcMinutes(value); case AngleUnit.ArcSeconds: return FromArcSeconds(value); case AngleUnit.AngularMil: return FromAngularMil(value); default: throw new ArgumentOutOfRangeException(nameof(sourceUnit), sourceUnit, null); } } /// /// Unwraps a set of values so a comparable mathematical operation can be applied. /// /// Sequence of values to unwrap. /// Unwrapped set of values. /// /// For Angles that wrap, e.g., between -180 and +180, this algorithm unwraps the values to make the values mathematically comparable. /// public static IEnumerable Unwrap(IEnumerable source) { double[] sourceAngles = source.Select(angle => angle.m_value).ToArray(); return Unwrap(sourceAngles).Select(angle => new Angle(angle)); } /// /// Calculates an average of the specified sequence of values. /// /// Sequence of values over which to calculate average. /// Average of the specified sequence of values. /// /// For Angles that wrap, e.g., between -180 and +180, this algorithm takes the wrapping into account when calculating the average. /// public static Angle Average(IEnumerable source) { double[] sourceAngles = source.Select(angle => angle.m_value).ToArray(); return new Angle(Unwrap(sourceAngles).Average()).ToRange(-Math.PI, false); } private static double[] Unwrap(double[] sourceAngles) { double[] unwrappedAngles = new double[sourceAngles.Length]; if (sourceAngles.Length > 0) { double offset = 0.0D, dis0, dis1, dis2; unwrappedAngles[0] = sourceAngles[0]; // Unwrap all source angles for (int i = 1; i < sourceAngles.Length; i++) { dis0 = Math.Abs(sourceAngles[i] + offset - unwrappedAngles[i - 1]); dis1 = Math.Abs(sourceAngles[i] + offset - unwrappedAngles[i - 1] + TwoPI); dis2 = Math.Abs(sourceAngles[i] + offset - unwrappedAngles[i - 1] - TwoPI); if (dis1 < dis0 && dis1 < dis2) offset = offset + TwoPI; else if (dis2 < dis0 && dis2 < dis1) offset = offset - TwoPI; unwrappedAngles[i] = sourceAngles[i] + offset; } } return unwrappedAngles; } #endregion } }