Merge pull request #1 from zigurous/release/1.2.0

Release/1.2.0

Author: adamgraham

.github/workflows/generate-docs.yml

@@ -0,0 +1,23 @@
+name: Generate Docs
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  generate:
+    name: Docs
+    uses: zigurous/docs/.github/workflows/unity-package.yml@main
+    with:
+      package_title: "Math Utils"
+      package_base_path: com.zigurous.math
+      package_workflow: generate-docs.yml
+      package_artifact: docs
+    secrets:
+      token: ${{ secrets.DOCS_TOKEN }}

.github/workflows/generate_docs.yml

@@ -5,6 +5,35 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.2.0] - 2023/06/20
+
+### Added
+
+- Constructors to specify the amount of digits on `FloatEqualityComparer` and `DoubleEqualityComparer`
+- Overloads for `short` and `long` number abbreviations
+- New `ComparisonSign` enum
+- New `Bounds` extensions
+  - `Lerp`
+  - `LerpUnclamped`
+  - `InverseLerp`
+  - `CalculateScale`
+- New `Rect` extensions
+  - `Contains`
+  - `Encapsulate`
+  - `Lerp`
+  - `LerpUnclamped`
+  - `InverseLerp`
+- New `Transform` extensions
+  - `AveragePositionOfChildren`
+  - `CenterPositionOfChildren`
+  - `Reset`
+  - `ResetLocal`
+  - `SetPosition`
+  - `SetLocalPosition`
+  - `SetEulerAngles`
+  - `SetLocalEulerAngles`
+  - `SetLocalScale`
+
 ## [1.1.1] - 2022/05/19
 
 ### Fixed

CHANGELOG.md

@@ -6,20 +6,36 @@ slug: "/manual/extensions"
 
 A large majority of the functionality provided by the **Math Utils** package comes from extension methods. All of the extension methods found throughout the project are focused around numbers, whether it be arithmetic operations, bitwise operations, math algorithms, and other utilities of varying complexity. Extensions are available for the following types:
 
-- [Array](/api/Zigurous.Math/ArrayExtensions)
-- [Bounds](/api/Zigurous.Math/BoundsExtensions)
-- [Collider](/api/Zigurous.Math/ColliderExtensions)
-- [Double](/api/Zigurous.Math/DoubleExtensions)
-- [Float](/api/Zigurous.Math/FloatExtensions)
-- [IComparable](/api/Zigurous.Math/ComparableExtensions)
-- [Int](/api/Zigurous.Math/IntExtensions)
-- [List](/api/Zigurous.Math/ListExtensions)
-- [Long](/api/Zigurous.Math/LongExtensions)
-- [Quaternion](/api/Zigurous.Math/QuaternionExtensions)
-- [Short](/api/Zigurous.Math/ShortExtensions)
-- [UInt](/api/Zigurous.Math/UIntExtensions)
-- [Vector2](/api/Zigurous.Math/Vector2Extensions)
-- [Vector2Int](/api/Zigurous.Math/Vector2IntExtensions)
-- [Vector3](/api/Zigurous.Math/Vector3Extensions)
-- [Vector3Int](/api/Zigurous.Math/Vector3IntExtensions)
-- [Vector4](/api/Zigurous.Math/Vector4Extensions)
+#### [Array](/api/Zigurous.Math/ArrayExtensions)
+
+#### [Bounds](/api/Zigurous.Math/BoundsExtensions)
+
+#### [Collider](/api/Zigurous.Math/ColliderExtensions)
+
+#### [Double](/api/Zigurous.Math/DoubleExtensions)
+
+#### [Float](/api/Zigurous.Math/FloatExtensions)
+
+#### [IComparable](/api/Zigurous.Math/ComparableExtensions)
+
+#### [Int](/api/Zigurous.Math/IntExtensions)
+
+#### [List](/api/Zigurous.Math/ListExtensions)
+
+#### [Long](/api/Zigurous.Math/LongExtensions)
+
+#### [Quaternion](/api/Zigurous.Math/QuaternionExtensions)
+
+#### [Short](/api/Zigurous.Math/ShortExtensions)
+
+#### [UInt](/api/Zigurous.Math/UIntExtensions)
+
+#### [Vector2](/api/Zigurous.Math/Vector2Extensions)
+
+#### [Vector2Int](/api/Zigurous.Math/Vector2IntExtensions)
+
+#### [Vector3](/api/Zigurous.Math/Vector3Extensions)
+
+#### [Vector3Int](/api/Zigurous.Math/Vector3IntExtensions)
+
+#### [Vector4](/api/Zigurous.Math/Vector4Extensions)

Documentation~/articles/extensions.md

@@ -8,18 +8,24 @@ The **Math Utils** package provides extensions and utilities for working with nu
 
 <hr/>
 
-## 📌 Overview
+## Overview
 
-- [Scripting API](/api/Zigurous.Math)
-- [Installation](/manual/installation)
-- [Changelog](/changelog)
-- [License](/license)
+#### ⚙️ [Installation](/installation)
+
+#### 🧰 [Scripting API](/api/Zigurous.Math)
+
+#### 📋 [Changelog](/changelog)
+
+#### ⚖️ [License](/license)
 
 <hr/>
 
-## 📖 Reference
+## Reference
+
+#### 🔢 [Input Processors](/manual/processors)
+
+#### 🎲 [Random Values](/manual/random)
+
+#### 💯 [Number Abbreviations](/manual/abbreviations)
 
-- [Input Processors](/manual/processors)
-- [Random Chance](/manual/chance)
-- [Number Abbreviations](/manual/abbreviations)
-- [Extension Methods](/manual/extensions)
+#### 🔌 [Extension Methods](/manual/extensions)

Documentation~/articles/index.md

@@ -1,10 +1,10 @@
 ---
-slug: "/manual/chance"
+slug: "/manual/random"
 ---
 
-# Random Chance
+# Random
 
-The **Math Utils** package contains several functions for generating random chance values, including rolling dice, picking random playing cards, and other utility functions.
+The **Math Utils** package contains several functions for generating random values, including rolling dice, picking random playing cards, and other utility functions.
 
 <hr/>
 

Documentation~/articles/chance.md renamed to Documentation~/articles/random.md

@@ -7,7 +7,7 @@ The **Math Utils** package provides extensions and utilities for working with nu
 ## Reference
 
 - [Input Processors](https://docs.zigurous.com/com.zigurous.math/manual/processors)
-- [Random Chance](https://docs.zigurous.com/com.zigurous.math/manual/chance)
+- [Random Values](https://docs.zigurous.com/com.zigurous.math/manual/random)
 - [Number Abbreviations](https://docs.zigurous.com/com.zigurous.math/manual/abbreviations)
 - [Extension Methods](https://docs.zigurous.com/com.zigurous.math/manual/extensions)
 

README.md

@@ -0,0 +1,69 @@
+namespace Zigurous.Math
+{
+    /// <summary>
+    /// A mathematical sign that can be used to compare two values.
+    /// </summary>
+    public enum ComparisonSign
+    {
+        /// <summary>
+        /// <c>a == b</c>
+        /// </summary>
+        Equal,
+
+        /// <summary>
+        /// <c>a != b</c>
+        /// </summary>
+        NotEqual,
+
+        /// <summary>
+        /// <c>a &gt; b</c>
+        /// </summary>
+        GreaterThan,
+
+        /// <summary>
+        /// <c>a &gt;= b</c>
+        /// </summary>
+        GreaterThanOrEqual,
+
+        /// <summary>
+        /// <c>a &lt; b</c>
+        /// </summary>
+        LessThan,
+
+        /// <summary>
+        /// <c>a &lt;= b</c>
+        /// </summary>
+        LessThanOrEqual,
+    }
+
+    /// <summary>
+    /// Extension methods for <see cref="ComparisonSign"/>.
+    /// </summary>
+    public static class ComparisonSignExtensions
+    {
+        /// <summary>
+        /// Compares two values using the comparison sign.
+        /// </summary>
+        /// <typeparam name="T">The type of values to compare.</typeparam>
+        /// <param name="sign">The comparison sign.</param>
+        /// <param name="a">The first value to compare.</param>
+        /// <param name="b">The second value to compare.</param>
+        /// <returns>The result of the comparison, either true or false.</returns>
+        public static bool Compare<T>(this ComparisonSign sign, T a, T b)
+            where T : System.IComparable<T>
+        {
+            switch (sign)
+            {
+                case ComparisonSign.Equal: return a.CompareTo(b) == 0;
+                case ComparisonSign.NotEqual: return a.CompareTo(b) != 0;
+                case ComparisonSign.GreaterThan: return a.CompareTo(b) > 0;
+                case ComparisonSign.GreaterThanOrEqual: return a.CompareTo(b) >= 0;
+                case ComparisonSign.LessThan: return a.CompareTo(b) < 0;
+                case ComparisonSign.LessThanOrEqual: return a.CompareTo(b) <= 0;
+                default: return false;
+            }
+        }
+
+    }
+
+}

Runtime/ComparisonSign.cs

@@ -11,7 +11,25 @@ public sealed class DoubleEqualityComparer : IEqualityComparer<double>
         /// <summary>
         /// The number of decimal digits to compare when determining equality.
         /// </summary>
-        public int digits = 3;
+        public int digits;
+
+        /// <summary>
+        /// Creates a new DoubleEqualityComparer with a default of 3 decimal
+        /// digits to compare when determining equality.
+        /// </summary>
+        public DoubleEqualityComparer()
+        {
+            this.digits = 3;
+        }
+
+        /// <summary>
+        /// Creates a new DoubleEqualityComparer with the specified number of
+        /// decimal digits to compare when determining equality.
+        /// </summary>
+        public DoubleEqualityComparer(int digits)
+        {
+            this.digits = digits;
+        }
 
         /// <summary>
         /// Checks the equality of two double values.