Differences

This shows you the differences between two versions of the page.

--- manual:chapter6:stack:cmd_depth [2019/10/02 15:09]
jojo1973 Indentation of the example code
+++ manual:chapter6:stack:cmd_depth [2021/09/19 13:28] (current)
jojo1973 Redone
@@ Line 1: / Line 1: @@
 ==== DEPTH ====
+<callout type="primary" color="" icon="fa fa-book" title="Synopsis">
 ----
-<callout type="primary" color="" icon="fa fa-comment" title="Description">
+Return the number of items present on the stack
-----
-Returns the number of items present on the stack before executing the command.
 </callout>
-<callout color="crimson" icon="fa fa-indent" title="Stack Diagram">
+<callout color="green" icon="fa fa-indent" title="Stack Diagram">
 ----
 ^  __Input Stack__  ^  ^  __Output Stack__  ^
-|    |  **→**  |  **I**  |
+|  ****  |  **→**  |  **I<sub>depth</sub>**  |
-|  //Level 1//  |  **→**  |  //Level 1//  |
+|  //Level 1//  |  //→//  |  //Level 1//  |
 {{page>manual:chapter6:aux:legend&nofooter&noeditbtn&inline}}
-| {{fa>times?lg&color=red}} **Support for inclusion in symbolic expressions**  |
+| **Keyword type**  | [[manual:chapter5:basics#commands|Command]]  ||
-| {{fa>times?lg&color=red}} **Support for parallel list processing**  |
+| **Parallel list processing capabilities**  | [[manual:chapter5:listproc#group-1commands-that-cannot-parallel-process|Group 1]]  | //Commands that cannot parallel process//  |
-| {{fa>times?lg&color=red}} **Affected by flags**  |
+| **Affected by flags**  | [[manual:appendix:flags#flag-28|-28]]  | //Enable RPN stack mode//  |
+| ::: | [[manual:appendix:flags#flag-29|-29]]  | //RPN stack depth//  |
 </callout>
-<callout type="success" icon="true" title="Compatibility">
+<callout color="orangered" icon="fa fa-comment" title="Description">
 ----
-This command is fully compatible with userRPL.
+The ''DEPTH'' command puts on the level 1 of the stack the number of elements present on it before executing the command itself.
+When the stack is in RPN mode ''DEPTH'' always returns ''4'' or ''8'', depending on the selected stack depth.
+</callout>
+<callout type="warning" icon="true" title="Compatibility">
+----
+''DEPTH'' is not fully equivalent to its **userRPL** counterpart.
+In particular:
+  * In **userRPL** RPN stack mode is not supported.
 </callout>
 <callout type="info" icon="true" title="Usage">
 ----
-The following program:
+**__Input__**
 <code>
-« 123
+:
-  DEPTH
+:                                   1_m
-»
+:                       { 'X' 'Y' 'Z' }
+:                    "This is a string"
+…………………………………………………………………………………………………………
+DEPTH
+</code>
+\\
+**__Output__**
+<code>
+:                                   1_m
+:                       { 'X' 'Y' 'Z' }
+:                    "This is a string"
+:                                     3
+…………………………………………………………………………………………………………
 </code>
-will result in a stack containing ''123'' and ''1'' when executed on an empty stack.
 </callout>
-<callout color="darkslategray" icon="fa fa-hand-o-right" title="Related Commands">
+<callout color="darkgray" icon="fa fa-hand-o-right" title="Related Commands">
+----
 {{page>manual:chapter6:stack&nofooter&noeditbtn&inline}}
 </callout>