Merge pull request #1 from stefan-baumann/master

Some improvements

Author: Dominic Beger

SharpMath/Equations/Exceptions/EquationNotSolvableException.cs

@@ -1,11 +1,20 @@
 // Author: Dominic Beger (Trade/ProgTrade) 2016
+// Improvements: Stefan Baumann 2016
 
 using System;
 
 namespace SharpMath.Equations.Exceptions
 {
+    /// <summary>
+    /// The exception that is thrown when an equation is not solvable.
+    /// </summary>
+    /// <seealso cref="System.Exception" />
     public class EquationNotSolvableException : Exception
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="EquationNotSolvableException"/> class.
+        /// </summary>
+        /// <param name="message">The message that describes the error.</param>
         public EquationNotSolvableException(string message) : base(message)
         {
         }

SharpMath/Expressions/Exceptions/ParserException.cs

@@ -1,11 +1,20 @@
 // Author: Dominic Beger (Trade/ProgTrade) 2016
+// Improvements: Stefan Baumann 2016
 
 using System;
 
 namespace SharpMath.Expressions.Exceptions
 {
+    /// <summary>
+    /// The exception that is thrown when the parser encountered an invalid token.
+    /// </summary>
+    /// <seealso cref="System.Exception" />
     public class ParserException : Exception
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ParserException"/> class.
+        /// </summary>
+        /// <param name="message">The message that describes the error.</param>
         public ParserException(string message)
             : base(message)
         {

SharpMath/FloatingNumber.cs

@@ -1,4 +1,5 @@
 // Author: Dominic Beger (Trade/ProgTrade) 2016
+// Improvements: Stefan Baumann 2016
 
 using System;
 
@@ -32,8 +33,8 @@ public static bool AreApproximatelyEqual(float firstNumber, float secondNumber)
         /// <param name="epsilon">The epsilon value that represents the tolerance.</param>
         /// <returns>Returns <c>true</c>, if they are approximately equal, otherwise <c>false</c>.</returns>
         public static bool AreApproximatelyEqual(float firstNumber, float secondNumber, double epsilon)
-            => Math.Abs(firstNumber - secondNumber) <= Epsilon;
-
+            => Math.Abs(firstNumber - secondNumber) <= epsilon;
+        
         /// <summary>
         ///     Determines whether two floating numbers are approximately equal to each other using the <see cref="Epsilon" />
         ///     value.
@@ -52,6 +53,6 @@ public static bool AreApproximatelyEqual(double firstNumber, double secondNumber
         /// <param name="epsilon">The epsilon value that represents the tolerance.</param>
         /// <returns>Returns <c>true</c>, if they are approximately equal, otherwise <c>false</c>.</returns>
         public static bool AreApproximatelyEqual(double firstNumber, double secondNumber, double epsilon)
-            => Math.Abs(firstNumber - secondNumber) <= Epsilon;
+            => Math.Abs(firstNumber - secondNumber) <= epsilon;
     }
 }

SharpMath/FloatingNumberExtensions.cs

@@ -1,4 +1,5 @@
 // Author: Dominic Beger (Trade/ProgTrade) 2016
+// Improvements: Stefan Baumann 2016
 
 namespace SharpMath
 {
@@ -14,7 +15,7 @@ public static class FloatingNumberExtensions
         /// <param name="number">The current <see cref="float" />.</param>
         /// <param name="other">The other <see cref="float" />.</param>
         /// <returns>Returns <c>true</c>, if they are approximately equal, otherwise <c>false</c>.</returns>
-        public static bool AreApproximatelyEqual(this float number, float other)
+        public static bool IsApproximatelyEqualTo(this float number, float other)
             => FloatingNumber.AreApproximatelyEqual(number, other);
 
         /// <summary>
@@ -24,7 +25,7 @@ public static bool AreApproximatelyEqual(this float number, float other)
         /// <param name="other">The other <see cref="float" />.</param>
         /// <param name="epsilon">The epsilon value that represents the tolerance.</param>
         /// <returns>Returns <c>true</c>, if they are approximately equal, otherwise <c>false</c>.</returns>
-        public static bool AreApproximatelyEqual(this float number, float other, double epsilon)
+        public static bool IsApproximatelyEqualTo(this float number, float other, double epsilon)
             => FloatingNumber.AreApproximatelyEqual(number, other, epsilon);
 
         /// <summary>
@@ -34,7 +35,7 @@ public static bool AreApproximatelyEqual(this float number, float other, double
         /// <param name="number">The current <see cref="float" />.</param>
         /// <param name="other">The other <see cref="float" />.</param>
         /// <returns>Returns <c>true</c>, if they are approximately equal, otherwise <c>false</c>.</returns>
-        public static bool AreApproximatelyEqual(double number, double other)
+        public static bool IsApproximatelyEqualTo(this double number, double other)
             => FloatingNumber.AreApproximatelyEqual(number, other);
 
         /// <summary>
@@ -44,7 +45,7 @@ public static bool AreApproximatelyEqual(double number, double other)
         /// <param name="other">The other <see cref="float" />.</param>
         /// <param name="epsilon">The epsilon value that represents the tolerance.</param>
         /// <returns>Returns <c>true</c>, if they are approximately equal, otherwise <c>false</c>.</returns>
-        public static bool AreApproximatelyEqual(double number, double other, double epsilon)
+        public static bool IsApproximatelyEqualTo(this double number, double other, double epsilon)
             => FloatingNumber.AreApproximatelyEqual(number, other, epsilon);
     }
 }

SharpMath/Geometry/Exceptions/DimensionException.cs

@@ -1,11 +1,20 @@
 // Author: Dominic Beger (Trade/ProgTrade) 2016
+// Improvements: Stefan Baumann 2016
 
 using System;
 
 namespace SharpMath.Geometry.Exceptions
 {
+    /// <summary>
+    /// The exception that is thrown when the dimension count of two vectors is different.
+    /// </summary>
+    /// <seealso cref="System.Exception" />
     public class DimensionException : Exception
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="DimensionException"/> class.
+        /// </summary>
+        /// <param name="message">The message that describes the error.</param>
         public DimensionException(string message)
             : base(message)
         {

SharpMath/Geometry/Line2D.cs

@@ -1,4 +1,5 @@
 // Author: Dominic Beger (Trade/ProgTrade) 2016
+// Improvements: Stefan Baumann 2016
 
 using System;
 
@@ -7,7 +8,7 @@ namespace SharpMath.Geometry
     /// <summary>
     ///     Represents a line in a 2-dimensional room.
     /// </summary>
-    public class Line2D
+    public class Line2D : IEquatable<Line2D>
     {
         /// <summary>
         ///     Initializes a new instance of the <see cref="Line2D" /> class.
@@ -158,5 +159,77 @@ public Point2D GetPoint(double x)
         {
             return new Point2D(x, Slope*x + Offset);
         }
+
+        /// <summary>
+        /// Determines whether the specified <see cref="System.Object" /> is equal to this instance.
+        /// </summary>
+        /// <param name="obj">The <see cref="System.Object" /> to compare with this instance.</param>
+        /// <returns>
+        ///   <c>true</c> if the specified <see cref="System.Object" /> is equal to this instance; otherwise, <c>false</c>.
+        /// </returns>
+        public override bool Equals(object obj)
+        {
+            return obj == null ? this == null : obj is Line2D && ((Line2D)obj).Offset == Offset && ((Line2D)obj).Slope == Slope;
+        }
+
+        /// <summary>
+        /// Determines whether the specified <see cref="Line2D" /> is equal to this instance.
+        /// </summary>
+        /// <param name="other">The <see cref="Line2D" /> to compare with this instance.</param>
+        /// <returns>
+        ///   <c>true</c> if the specified <see cref="Line2D" /> is equal to this instance; otherwise, <c>false</c>.
+        /// </returns>
+        public bool Equals(Line2D other)
+        {
+            return other == null ? this == null : other.Offset == Offset && other.Slope == Slope;
+        }
+
+        /// <summary>
+        /// Returns a hash code for this instance.
+        /// </summary>
+        /// <returns>
+        /// A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. 
+        /// </returns>
+        public override int GetHashCode()
+        {
+            return Offset.GetHashCode() ^ Slope.GetHashCode();
+        }
+
+        /// <summary>
+        /// Returns a <see cref="System.String" /> that represents this instance.
+        /// </summary>
+        /// <returns>
+        /// A <see cref="System.String" /> that represents this instance.
+        /// </returns>
+        public override string ToString()
+        {
+            return string.Format("Line2D [Offset={0}; Slope={1}]", Offset, Slope);
+        }
+
+        /// <summary>
+        /// Determines whether the two specified <see cref="Line2D" /> instances are equal to each other.
+        /// </summary>
+        /// <param name="left">The first <see cref="Line2D" />.</param>
+        /// <param name="right">The <see cref="Line2D" /> to compare with the other <see cref="Line2D" />.</param>
+        /// <returns>
+        ///   <c>true</c> if the two specified <see cref="Line2D" /> are equal to each other; otherwise, <c>false</c>.
+        /// </returns>
+        public static bool operator ==(Line2D left, Line2D right)
+        {
+            return left.Equals(right);
+        }
+
+        /// <summary>
+        /// Determines whether the two specified <see cref="Line2D" /> instances are not equal to each other.
+        /// </summary>
+        /// <param name="left">The first <see cref="Line2D" />.</param>
+        /// <param name="right">The <see cref="Line2D" /> to compare with the other <see cref="Line2D" />.</param>
+        /// <returns>
+        ///   <c>true</c> if the two specified <see cref="Line2D" /> are not equal to each other; otherwise, <c>false</c>.
+        /// </returns>
+        public static bool operator !=(Line2D left, Line2D right)
+        {
+            return !left.Equals(right);
+        }
     }
 }

SharpMath/Geometry/Line3D.cs

@@ -1,4 +1,5 @@
 // Author: Dominic Beger (Trade/ProgTrade) 2016
+// Improvements: Stefan Baumann 2016
 
 using System;
 
@@ -7,7 +8,7 @@ namespace SharpMath.Geometry
     /// <summary>
     ///     Represents a 3D-line.
     /// </summary>
-    public class Line3D
+    public class Line3D : IEquatable<Line3D>
     {
         private Vector3 _direction;
 
@@ -81,5 +82,77 @@ public bool IsPointOnLine(Point3D point)
 
             return true;
         }
+
+        /// <summary>
+        /// Determines whether the specified <see cref="System.Object" /> is equal to this instance.
+        /// </summary>
+        /// <param name="obj">The <see cref="System.Object" /> to compare with this instance.</param>
+        /// <returns>
+        ///   <c>true</c> if the specified <see cref="System.Object" /> is equal to this instance; otherwise, <c>false</c>.
+        /// </returns>
+        public override bool Equals(object obj)
+        {
+            return obj == null ? this == null : obj is Line3D && ((Line3D)obj).Direction == Direction && ((Line3D)obj).Point == Point;
+        }
+
+        /// <summary>
+        /// Determines whether the specified <see cref="Line3D" /> is equal to this instance.
+        /// </summary>
+        /// <param name="other">The <see cref="Line3D" /> to compare with this instance.</param>
+        /// <returns>
+        ///   <c>true</c> if the specified <see cref="Line3D" /> is equal to this instance; otherwise, <c>false</c>.
+        /// </returns>
+        public bool Equals(Line3D other)
+        {
+            return other == null ? this == null : other.Direction == Direction && other.Point == Point;
+        }
+
+        /// <summary>
+        /// Returns a hash code for this instance.
+        /// </summary>
+        /// <returns>
+        /// A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. 
+        /// </returns>
+        public override int GetHashCode()
+        {
+            return Direction.GetHashCode() ^ Point.GetHashCode();
+        }
+
+        /// <summary>
+        /// Returns a <see cref="System.String" /> that represents this instance.
+        /// </summary>
+        /// <returns>
+        /// A <see cref="System.String" /> that represents this instance.
+        /// </returns>
+        public override string ToString()
+        {
+            return string.Format("Line3D [Direction={0}; Point={1}]", Direction, Point);
+        }
+
+        /// <summary>
+        /// Determines whether the two specified <see cref="Line3D" /> instances are equal to each other.
+        /// </summary>
+        /// <param name="left">The first <see cref="Line3D" />.</param>
+        /// <param name="right">The <see cref="Line3D" /> to compare with the other <see cref="Line3D" />.</param>
+        /// <returns>
+        ///   <c>true</c> if the two specified <see cref="Line3D" /> are equal to each other; otherwise, <c>false</c>.
+        /// </returns>
+        public static bool operator ==(Line3D left, Line3D right)
+        {
+            return left.Equals(right);
+        }
+
+        /// <summary>
+        /// Determines whether the two specified <see cref="Line3D" /> instances are not equal to each other.
+        /// </summary>
+        /// <param name="left">The first <see cref="Line3D" />.</param>
+        /// <param name="right">The <see cref="Line3D" /> to compare with the other <see cref="Line3D" />.</param>
+        /// <returns>
+        ///   <c>true</c> if the two specified <see cref="Line3D" /> are not equal to each other; otherwise, <c>false</c>.
+        /// </returns>
+        public static bool operator !=(Line3D left, Line3D right)
+        {
+            return !left.Equals(right);
+        }
     }
 }

SharpMath/Geometry/Point.cs

@@ -1,4 +1,5 @@
 // Author: Dominic Beger (Trade/ProgTrade) 2016
+// Improvements: Stefan Baumann 2016
 
 using System;
 using System.Collections;
@@ -97,7 +98,11 @@ public Vector PositionVector
         /// </returns>
         public IEnumerator<double> GetEnumerator()
         {
-            return new PointEnumerator(this);
+            for (int i = 0; i < this.Dimension; i++)
+            {
+                yield return this[(uint)i];
+            }
+            yield break;
         }
 
         /// <summary>
@@ -108,7 +113,11 @@ public IEnumerator<double> GetEnumerator()
         /// </returns>
         IEnumerator IEnumerable.GetEnumerator()
         {
-            return new PointEnumerator(this);
+            for (int i = 0; i < this.Dimension; i++)
+            {
+                yield return this[(uint)i];
+            }
+            yield break;
         }
 
         public bool Equals(Point other)