Added Temperature implementation (#30)

Author: MrMatthewLayton

OnixLabs.Core.UnitTests/Units/TemperatureTests.cs

@@ -50,4 +50,5 @@
         <Using Include="OnixLabs.Core.Collections.Collection" Static="True" />
     </ItemGroup>
 
+
 </Project>

OnixLabs.Core/OnixLabs.Core.csproj

@@ -0,0 +1,106 @@
+// Copyright © 2020 ONIXLabs
+// 
+// Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
+// 
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+namespace OnixLabs.Core.Units;
+
+public readonly partial struct Temperature<T>
+{
+    /// <summary>
+    /// Computes the sum of the specified <see cref="Temperature{T}"/> values.
+    /// </summary>
+    /// <param name="left">The left-hand value to add to.</param>
+    /// <param name="right">The right-hand value to add.</param>
+    /// <returns>Returns the sum of the specified <see cref="Temperature{T}"/> values.</returns>
+    public static Temperature<T> Add(Temperature<T> left, Temperature<T> right)
+    {
+        return new Temperature<T>(left.Kelvin + right.Kelvin);
+    }
+
+    /// <summary>
+    /// Computes the difference between the specified <see cref="Temperature{T}"/> values.
+    /// </summary>
+    /// <param name="left">The left-hand value to subtract from.</param>
+    /// <param name="right">The right-hand value to subtract.</param>
+    /// <returns>Returns the difference between the specified <see cref="Temperature{T}"/> values.</returns>
+    public static Temperature<T> Subtract(Temperature<T> left, Temperature<T> right)
+    {
+        return new Temperature<T>(left.Kelvin - right.Kelvin);
+    }
+
+    /// <summary>
+    /// Computes the product of the specified <see cref="Temperature{T}"/> values.
+    /// </summary>
+    /// <param name="left">The left-hand value to multiply.</param>
+    /// <param name="right">The right-hand value to multiply by.</param>
+    /// <returns>Returns the product of the specified <see cref="Temperature{T}"/> values.</returns>
+    public static Temperature<T> Multiply(Temperature<T> left, Temperature<T> right)
+    {
+        return new Temperature<T>(left.Kelvin * right.Kelvin);
+    }
+
+    /// <summary>
+    /// Computes the quotient of the specified <see cref="Temperature{T}"/> values.
+    /// </summary>
+    /// <param name="left">The left-hand value to divide.</param>
+    /// <param name="right">The right-hand value to divide by.</param>
+    /// <returns>Returns the quotient of the specified <see cref="Temperature{T}"/> values.</returns>
+    public static Temperature<T> Divide(Temperature<T> left, Temperature<T> right)
+    {
+        return new Temperature<T>(left.Kelvin / right.Kelvin);
+    }
+
+    /// <summary>
+    /// Computes the sum of the specified <see cref="Temperature{T}"/> values.
+    /// </summary>
+    /// <param name="left">The left-hand value to add to.</param>
+    /// <param name="right">The right-hand value to add.</param>
+    /// <returns>Returns the sum of the specified <see cref="Temperature{T}"/> values.</returns>
+    public static Temperature<T> operator +(Temperature<T> left, Temperature<T> right)
+    {
+        return Add(left, right);
+    }
+
+    /// <summary>
+    /// Computes the difference between the specified <see cref="Temperature{T}"/> values.
+    /// </summary>
+    /// <param name="left">The left-hand value to subtract from.</param>
+    /// <param name="right">The right-hand value to subtract.</param>
+    /// <returns>Returns the difference between the specified <see cref="Temperature{T}"/> values.</returns>
+    public static Temperature<T> operator -(Temperature<T> left, Temperature<T> right)
+    {
+        return Subtract(left, right);
+    }
+
+    /// <summary>
+    /// Computes the product of the specified <see cref="Temperature{T}"/> values.
+    /// </summary>
+    /// <param name="left">The left-hand value to multiply.</param>
+    /// <param name="right">The right-hand value to multiply by.</param>
+    /// <returns>Returns the product of the specified <see cref="Temperature{T}"/> values.</returns>
+    public static Temperature<T> operator *(Temperature<T> left, Temperature<T> right)
+    {
+        return Multiply(left, right);
+    }
+
+    /// <summary>
+    /// Computes the quotient of the specified <see cref="Temperature{T}"/> values.
+    /// </summary>
+    /// <param name="left">The left-hand value to divide.</param>
+    /// <param name="right">The right-hand value to divide by.</param>
+    /// <returns>Returns the quotient of the specified <see cref="Temperature{T}"/> values.</returns>
+    public static Temperature<T> operator /(Temperature<T> left, Temperature<T> right)
+    {
+        return Divide(left, right);
+    }
+}

OnixLabs.Core/Units/Temperature.Arithmetic.cs

@@ -0,0 +1,100 @@
+// Copyright © 2020 ONIXLabs
+// 
+// Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
+// 
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+using System;
+
+namespace OnixLabs.Core.Units;
+
+public readonly partial struct Temperature<T> : IComparable<Temperature<T>>, IComparable
+{
+    /// <summary>
+    /// Compares two <see cref="Temperature{T}"/> values and returns an integer that indicates
+    /// whether the left-hand value is less than, equal to, or greater than the right-hand value. 
+    /// </summary>
+    /// <param name="left">The left-hand value to compare.</param>
+    /// <param name="right">The right-hand value to compare.</param>
+    /// <returns>Returns a value that indicates the relative order of the objects being compared.</returns>
+    public static int Compare(Temperature<T> left, Temperature<T> right)
+    {
+        return left.Kelvin.CompareTo(right.Kelvin);
+    }
+
+    /// <summary>
+    /// Compares the current instance with another object of the same type and returns an integer that indicates
+    /// whether the current instance precedes, follows, or occurs in the same position in the sort order as the
+    /// other object.
+    /// </summary>
+    /// <param name="other">An object to compare with this instance.</param>
+    /// <returns>Returns a value that indicates the relative order of the objects being compared.</returns>
+    public int CompareTo(Temperature<T> other)
+    {
+        return Compare(this, other);
+    }
+
+    /// <summary>
+    /// Compares the current instance with another object of the same type and returns an integer that indicates
+    /// whether the current instance precedes, follows, or occurs in the same position in the sort order as the
+    /// other object.
+    /// </summary>
+    /// <param name="obj">An object to compare with this instance.</param>
+    /// <returns>Returns a value that indicates the relative order of the objects being compared.</returns>
+    public int CompareTo(object? obj)
+    {
+        return this.CompareObject(obj);
+    }
+
+    /// <summary>
+    /// Performs a greater than comparison check between two <see cref="Temperature{T}"/> values.
+    /// </summary>
+    /// <param name="left">The left-hand value to compare.</param>
+    /// <param name="right">The right-hand value to compare.</param>
+    /// <returns>Returns true if the left-hand operand is greater than right-hand operand; otherwise, false.</returns>
+    public static bool operator >(Temperature<T> left, Temperature<T> right)
+    {
+        return Compare(left, right) is 1;
+    }
+
+    /// <summary>
+    /// Performs a greater than or equal comparison check between two <see cref="Temperature{T}"/> values.
+    /// </summary>
+    /// <param name="left">The left-hand value to compare.</param>
+    /// <param name="right">The right-hand value to compare.</param>
+    /// <returns>Returns true if the left-hand operand is greater than or equal to right-hand operand; otherwise, false.</returns>
+    public static bool operator >=(Temperature<T> left, Temperature<T> right)
+    {
+        return Compare(left, right) is 1 or 0;
+    }
+
+    /// <summary>
+    /// Performs a less than comparison check between two <see cref="Temperature{T}"/> values.
+    /// </summary>
+    /// <param name="left">The left-hand value to compare.</param>
+    /// <param name="right">The right-hand value to compare.</param>
+    /// <returns>Returns true if the left-hand operand is less than right-hand operand; otherwise, false.</returns>
+    public static bool operator <(Temperature<T> left, Temperature<T> right)
+    {
+        return Compare(left, right) is -1;
+    }
+
+    /// <summary>
+    /// Performs a less than or equal comparison check between two <see cref="Temperature{T}"/> values.
+    /// </summary>
+    /// <param name="left">The left-hand value to compare.</param>
+    /// <param name="right">The right-hand value to compare.</param>
+    /// <returns>Returns true if the left-hand operand is less than or equal to right-hand operand; otherwise, false.</returns>
+    public static bool operator <=(Temperature<T> left, Temperature<T> right)
+    {
+        return Compare(left, right) is -1 or 0;
+    }
+}

OnixLabs.Core/Units/Temperature.Comparable.cs

@@ -0,0 +1,28 @@
+// Copyright © 2020 ONIXLabs
+// 
+// Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
+// 
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+namespace OnixLabs.Core.Units;
+
+public readonly partial struct Temperature<T>
+{
+    /// <summary>
+    /// Represents an absolute zero (0°K) <see cref="Temperature{T}"/> value.
+    /// </summary>
+    public static Temperature<T> Zero => default;
+
+    /// <summary>
+    /// Gets the default format.
+    /// </summary>
+    private const string DefaultFormat = "K";
+}

OnixLabs.Core/Units/Temperature.Constants.cs

@@ -0,0 +1,82 @@
+// Copyright © 2020 ONIXLabs
+// 
+// Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
+// 
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+using System;
+
+namespace OnixLabs.Core.Units;
+
+public readonly partial struct Temperature<T> : IEquatable<Temperature<T>>
+{
+    /// <summary>
+    /// Compares two instances of <see cref="Temperature{T}"/> to determine whether their values are equal.
+    /// </summary>
+    /// <param name="left">The left-hand value to compare.</param>
+    /// <param name="right">The right-hand value to compare.</param>
+    /// <returns>Returns true if the two specified instances are equal; otherwise, false.</returns>
+    public static bool Equals(Temperature<T> left, Temperature<T> right)
+    {
+        return left.Kelvin == right.Kelvin;
+    }
+
+    /// <summary>
+    /// Indicates whether the current object is equal to another object of the same type.
+    /// </summary>
+    /// <param name="other">An object to compare with this object.</param>
+    /// <returns>Returns true if the current object is equal to the other parameter; otherwise, false.</returns>
+    public bool Equals(Temperature<T> other)
+    {
+        return Equals(this, other);
+    }
+
+    /// <summary>
+    /// Checks for equality between this instance and another object.
+    /// </summary>
+    /// <param name="obj">The object to check for equality.</param>
+    /// <returns>true if the object is equal to this instance; otherwise, false.</returns>
+    public override bool Equals(object? obj)
+    {
+        return obj is Temperature<T> other && Equals(other);
+    }
+
+    /// <summary>
+    /// Serves as a hash code function for this instance.
+    /// </summary>
+    /// <returns>A hash code for this instance.</returns>
+    public override int GetHashCode()
+    {
+        return HashCode.Combine(Kelvin);
+    }
+
+    /// <summary>
+    /// Performs an equality check between two object instances.
+    /// </summary>
+    /// <param name="left">The left-hand value to compare.</param>
+    /// <param name="right">The right-hand value to compare.</param>
+    /// <returns>True if the instances are equal; otherwise, false.</returns>
+    public static bool operator ==(Temperature<T> left, Temperature<T> right)
+    {
+        return Equals(left, right);
+    }
+
+    /// <summary>
+    /// Performs an inequality check between two object instances.
+    /// </summary>
+    /// <param name="left">The left-hand value to compare.</param>
+    /// <param name="right">The right-hand value to compare.</param>
+    /// <returns>True if the instances are not equal; otherwise, false.</returns>
+    public static bool operator !=(Temperature<T> left, Temperature<T> right)
+    {
+        return !Equals(left, right);
+    }
+}