stabilize exponential (#721)

Author: Marcos-cat

changelog.md

@@ -22,6 +22,7 @@ This version is not yet released. If you are reading this on the website, then t
 - Add experimental sided subscripts for [`backward ˜`](https://uiua.org/docs/backward)
 - Add numeric subscripts for [`occurrences ⧆`](https://uiua.org/docs/occurrences)
 - Deprecate experimental [`progressive indexof ⊘`](https://uiua.org/docs/progressiveindexof) in favor of [`occurrences ⧆`](https://uiua.org/docs/occurrences)
+- Deprecate [`logarithm ₙ`](https://uiua.org/docs/logarithm) in favor of [`exponential ₑ`](https://uiua.org/docs/exponential)
 - Add the [`exponential ₑ`](https://uiua.org/docs/exponential) function, which computes the exponential function
 - Remove experimental `ln` in favor of [`exponential ₑ`](https://uiua.org/docs/exponential)
 - Remove previously deprecated `signature` and `stringify` modifiers

parser/src/defs.rs

@@ -217,16 +217,13 @@ primitive!(
     (1, Sqrt, MonadicPervasive, ("sqrt", '√')),
     /// Get the exponential of a number
     ///
-    /// ex: # Experimental!
-    ///   : ₑ 1
+    /// ex: ₑ 1
     /// You can get the natural logarithm with [un].
-    /// ex: # Experimental!
-    ///   : °ₑ e
+    /// ex: °ₑ e
     /// You can give a subscript to set the base.
-    /// ex: # Experimental!
-    ///   : ₑ₂ 8
+    /// ex: ₑ₂ 8
     ///   : ₑ₁₀ 6
-    (1, Exp, MonadicPervasive, ("exponential", 'ₑ'), { experimental: true }),
+    (1, Exp, MonadicPervasive, ("exponential", 'ₑ')),
     /// Get the sine of a number
     ///
     /// ex: ∿ 1

parser/src/primitive.rs

@@ -257,6 +257,7 @@ impl Primitive {
     pub fn deprecation_suggestion(&self) -> Option<String> {
         use Primitive::*;
         Some(match self {
+            Log => format!("use subscripted {} or {Anti}{Backward}{Pow}", Exp.format()),
             Rerank => format!(
                 "use subscripted {} or {Un}{By}({Len}{Shape}) instead",
                 Deshape.format()

site/primitives.json

@@ -640,6 +640,13 @@
     "class": "Environment",
     "description": "Get the executable extension for the current platform"
   },
+  "exponential": {
+    "glyph": "ₑ",
+    "args": 1,
+    "outputs": 1,
+    "class": "MonadicPervasive",
+    "description": "Get the exponential of a number"
+  },
   "fall": {
     "glyph": "⍖",
     "args": 1,
@@ -888,18 +895,13 @@
     "class": "DyadicPervasive",
     "description": "Compare for less than"
   },
-  "ln": {
-    "args": 1,
-    "outputs": 1,
-    "class": "MonadicPervasive",
-    "description": "Get the natural logarithm of a number"
-  },
   "logarithm": {
     "glyph": "ₙ",
     "args": 2,
     "outputs": 1,
     "class": "DyadicPervasive",
-    "description": "Get the based logarithm of a number"
+    "description": "Get the based logarithm of a number",
+    "deprecated": true
   },
   "map": {
     "args": 2,

site/src/other.rs

@@ -558,7 +558,7 @@ pub fn Subscripts() -> impl IntoView {
         subscript(Transpose, "Repeat", "# Experimental!\n△ ⍉₃ °△1_2_3_4_5"),
         subscript(Sqrt, "Nth root", "√₃ [8 27 125]"),
         subscript(Neg, "Turn one Nth in the complex plane", "⁅₃ ⍥₄⊸¯₄ 1"),
-        subscript(Exp, "Base N exponential", "# Experimental!\nₑ₂ 8"),
+        subscript(Exp, "Base N exponential", "ₑ₂ 8"),
         subscript(Round, "To N decimal places", "⁅₃ π"),
         subscript(Floor, "To N decimal places", "# Experimental!\n⌊₄ π\n⌊₄ τ"),
         subscript(Ceil, "To N decimal places", "# Experimental!\n⌈₄ π\n⌈₄ τ"),

site/src/primitive.rs

@@ -221,7 +221,7 @@ fn all_uns() -> impl IntoView {
             { inverse_row([Mul], Required, "", "°(×2) 5") }
             { inverse_row([Div], Required, "", "°(÷2) 5") }
             { inverse_row([Pow], Required, "", "°(ⁿ2) 36") }
-            { inverse_row([Log], Required, "", "°(ₙ2) 8") }
+            { inverse_row([Exp], No, "Natural logarithm", "°ₑ 10") }
             { inverse_row([Add, Dup], No, "", "°(+.) 10") }
             { inverse_row([Mul, Dup], No, "", "°(×.) 16") }
             { inverse_row([Atan], No, view!(<Prim prim=Sin/>" and cosine"), "°∠ π") }
@@ -311,7 +311,7 @@ fn all_unders() -> impl IntoView {
             { inverse_row([Div], Optional, view!("Optional "<Prim prim=Backward/>), "⍜÷(+1) 2 5") }
             { inverse_row([Modulus], Optional, view!("Optional "<Prim prim=Backward/>), "⍜◿(×10) 4 9") }
             { inverse_row([Pow], Optional, view!("Optional "<Prim prim=Backward/>), "⍜ⁿ(-9) 2 5") }
-            { inverse_row([Log], Optional, view!("Optional "<Prim prim=Backward/>), "⍜ₙ(+1) 3 8") }
+            { inverse_row([Exp], No, "", "⍜ₑ(ⁿ2) 7") }
             { inverse_row([Get], Optional, "", "⍜get(×10) @b map \"abc\" 1_2_3") }
             { inverse_row([Floor], No, "", "⍜⌊(×10) 1.5") }
             { inverse_row([Ceil], No, "", "⍜⌈(×10) 1.5") }

tests/under.ua

@@ -171,23 +171,22 @@
 ⍤⤙≍ 5 ⍜×∘ 3 5
 ⍤⤙≍ 5 ⍜÷∘ 3 5
 ⍤⤙≍ 5 ⍜×⁅1e12 ⍜ⁿ∘ 3 5
-⍤⤙≍ 5 ⍜×⁅1e12 ⍜ₙ∘ 3 5
 ⍤⤙≍ 5 ⍜×⁅1e12 ⍜(ⁿ˜÷1)∘ 3 5
 # Flipped Outside
 ⍤⤙≍ 5 ⍜˜+∘ 3 5
 ⍤⤙≍ 5 ⍜˜-∘ 3 5
 ⍤⤙≍ 5 ⍜˜×∘ 3 5
 ⍤⤙≍ 5 ⍜˜÷∘ 3 5
 ⍤⤙≍ 5 ⍜×⁅1e12 ⍜˜ⁿ∘ 3 5
-⍤⤙≍ 5 ⍜×⁅1e12 ⍜˜ₙ∘ 3 5
+⍤⤙≍ 5 ⍜×⁅1e12 ⍜˜÷∘ 3 5
 ⍤⤙≍ 5 ⍜×⁅1e12 ⍜(ⁿ⊙(˜÷1))∘ 3 5
 # Normal Inside
 ⍤⤙≍ 5 ⍜(+3)∘ 5
 ⍤⤙≍ 5 ⍜(-3)∘ 5
 ⍤⤙≍ 5 ⍜(×3)∘ 5
 ⍤⤙≍ 5 ⍜(÷3)∘ 5
 ⍤⤙≍ 5 ⍜×⁅1e12 ⍜(ⁿ3)∘ 5
-⍤⤙≍ 5 ⍜×⁅1e12 ⍜(ₙ3)∘ 5
+⍤⤙≍ 5 ⍜×⁅1e12 ⍜(÷3)∘ 5
 ⍤⤙≍ 5 ⍜×⁅1e12 ⍜(ⁿ˜÷1 3)∘ 5
 # Flipped Inside
 ⍤⤙≍ 5 ⍜(˜+3)∘ 5
@@ -200,8 +199,7 @@
 ⍤⤙≍ 5 ⍜°(˜÷3)∘ 5
 ⍤⤙≍ 5 ⍜×⁅1e12 ⍜(˜ⁿ3)∘ 5
 ⍤⤙≍ 5 ⍜×⁅1e12 ⍜°(˜ⁿ3)∘ 5
-⍤⤙≍ 5 ⍜×⁅1e12 ⍜(˜ₙ3)∘ 5
-⍤⤙≍ 5 ⍜×⁅1e12 ⍜°(˜ₙ3)∘ 5
+⍤⤙≍ 5 ⍜×⁅1e12 ⍜(˜÷3)∘ 5
 ⍤⤙≍ 5 ⍜×⁅1e12 ⍜(ⁿ˜÷1⊙3)∘ 5
 ⍤⤙≍ 5 ⍜×⁅1e12 ⍜°(ⁿ˜÷1⊙3)∘ 5
 # Dipped Inside
@@ -215,8 +213,6 @@
 ⍤⤙≍ 5 ⍜°(÷⊙3)∘ 5
 ⍤⤙≍ 5 ⍜×⁅1e12 ⍜(ⁿ⊙3)∘ 5
 ⍤⤙≍ 5 ⍜×⁅1e12 ⍜°(ⁿ⊙3)∘ 5
-⍤⤙≍ 5 ⍜×⁅1e12 ⍜(ₙ⊙3)∘ 5
-⍤⤙≍ 5 ⍜×⁅1e12 ⍜°(ₙ⊙3)∘ 5
 ⍤⤙≍ 5 ⍜×⁅1e12 ⍜(ⁿ˜÷1⊙3)∘ 5
 ⍤⤙≍ 5 ⍜×⁅1e12 ⍜°(ⁿ˜÷1⊙3)∘ 5
 

tests/units.ua

@@ -316,8 +316,6 @@ Test!÷
 Test!˜÷
 Test!ⁿ
 Test!˜ⁿ
-Test!ₙ
-Test!˜ₙ
 
 # Ana inverses
 ⍤⤙≍ [1 0] °/ℂ i