rainlance
/
amath
mirror of https://gitlab.com/rnger/amath
1
0
Fork 0
Code Releases 15 Wiki Activity
Simple command line calculator https://amath.innolan.net
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
212 Commits
1 Branch
210MB
Tree: 1.6.3
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '1.6.3'
${ noResults }
amath/text/help.cd

133 lines
12KB
Raw Permalink Blame History 

  1. #language english

  2. #version 0

  3. ; ###################################################################################

  4. ; ## Help texts for statement in amath

  5. ; ## ----------------------------------

  6. ; ##

  7. ; ## Generate code with:

  8. ; ## flexcat help.cd ../app/localize/help.h=help.sd

  9. ; ##

  10. ; ###################################################################################

  11. ; ## Copyright (c) 2015-2017 Carsten Sonne Larsen  <cs@innolan.dk>

  12. ; ## All rights reserved.

  13. ; ## 

  14. ; ## Redistribution and use in source and binary forms, with or without

  15. ; ## modification, are permitted provided that the following conditions are met:

  16. ; ## 

  17. ; ##  * Redistributions of source code must retain the above copyright notice, this

  18. ; ##    list of conditions and the following disclaimer.

  19. ; ##  

  20. ; ##  * Redistributions in binary form must reproduce the above copyright notice,

  21. ; ##    this list of conditions and the following disclaimer in the documentation

  22. ; ##    and/or other materials provided with the distribution.

  23. ; ##  

  24. ; ##  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"

  25. ; ##  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

  26. ; ##  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

  27. ; ##  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE

  28. ; ##  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL

  29. ; ##  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR

  30. ; ##  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER

  31. ; ##  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,

  32. ; ##  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

  33. ; ##  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

  34. ; ###################################################################################

  35. ; Introduction table - Symbol(0)

  36. symzero (/500/)

  37. Enter command or expression to evaluate.#NEWLINE##SYNTAXHIGHLIGHT#Example: 2+3-cos(3)#NORMALTEXT##NEWLINE# #NEWLINE#More help is available for designated topics.#NEWLINE#-------------------------------------------------#NEWLINE#functions    Base functions.#NEWLINE#trigon       Trigonometric functions.#NEWLINE#hyper        Hyperbolic functions.#NEWLINE#complex      Syntax for complex numbers.#NEWLINE#statements   Available statements.#NEWLINE#operators    Supported operators.#NEWLINE#-------------------------------------------------#NEWLINE##SYNTAXHIGHLIGHT#Example: help trigon#NEWLINE#

  38. ; Table of operators

  39. symoperator (/400/)

  40. -------------------------------------------------#NEWLINE#    +    Mathematical addition.#NEWLINE#    -    Mathematical subtraction.#NEWLINE#    *    Mathematical multiplication.#NEWLINE#    /    Mathematical division.#NEWLINE#    ^    Mathematical exponentiation.#NEWLINE#    =    Assignment of variable values.#NEWLINE#    |   Absolute value of number. #NEWLINE#-------------------------------------------------#NEWLINE#

  41. ; Table of functions

  42. symfunction (/500/)

  43. -------------------------------------------------#NEWLINE#abs     Absolute value of number.#NEWLINE#sgn     Mathematical signum function.#NEWLINE#round   Round to nearest integer number.#NEWLINE#trunc   Discard fraction part of number.#NEWLINE#floor   Mathematical floor function.#NEWLINE#ceil    Mathematical ceiling function.#NEWLINE#sqrt    Square root function (exp 1/2).#NEWLINE#cbrt    Cube root function (exp 1/3).#NEWLINE#lb      Binary logarithm function (base 2).#NEWLINE#ln      Natural logarithm function (base e).#NEWLINE#lg      Common logarithm function (base 10).#NEWLINE#-------------------------------------------------#NEWLINE##SYNTAXHIGHLIGHT#Example: round(1.55)#NORMALTEXT##NEWLINE#

  44. ; Table of trigonometric functions

  45. symtrigon (/500/)

  46. -------------------------------------------------#NEWLINE#sin     Trigonometric sine function.#NEWLINE#cos     Trigonometric cosine function.#NEWLINE#tan     Trigonometric tangent function.#NEWLINE#cot     Trigonometric cotangent function.#NEWLINE#sec     Trigonometric secant function.#NEWLINE#csc     Trigonometric cosecant function.#NEWLINE#asin    Inverse trigonometric sine function.#NEWLINE#acos    Inverse trigonometric cosine function.#NEWLINE#atan    Inverse trigonometric tangent function.#NEWLINE#acot    Inverse trigonometric cotangent function.#NEWLINE#asec    Inverse trigonometric secant function.#NEWLINE#acsc    Inverse trigonometric cosecant function.#NEWLINE#-------------------------------------------------#NEWLINE#Inverse functions can be prefixed with ar or arc #NEWLINE#instead of a.#NEWLINE#

  47. ; Table of hyperbolic functions

  48. symhyper (/500/)

  49. -------------------------------------------------#NEWLINE#sinh    Hyperbolic sine function.#NEWLINE#cosh    Hyperbolic cosine function.#NEWLINE#tanh    Hyperbolic tangent function.#NEWLINE#coth    Hyperbolic cotangent function.#NEWLINE#sech    Hyperbolic secant function.#NEWLINE#csch    Hyperbolic cosecant function.     #NEWLINE#asinh   Inverse hyperbolic sine function.#NEWLINE#acosh   Inverse hyperbolic cosine function.#NEWLINE#atanh   Inverse hyperbolic tangent function.#NEWLINE#acoth   Inverse hyperbolic cotangent function.#NEWLINE#asech   Inverse hyperbolic secant function.#NEWLINE#acsch   Inverse hyperbolic cosecant function.#NEWLINE#-------------------------------------------------#NEWLINE#Inverse functions can be prefixed with ar or arc #NEWLINE#instead of a.#NEWLINE#

  50. ; Table of statements

  51. symstatement (/1000/)

  52. ---------------------------------------------------------#NEWLINE#clear      Clear console window.#NEWLINE#def        Define function.#NEWLINE#delete     Delete variable or function.#NEWLINE#digits     Set number of significant digits.#NEWLINE#eval       Evaluate arithmetic expression.#NEWLINE#execute    Execute statements in a file.#NEWLINE#functions  Show list of user defined functions.#NEWLINE#input      Change numeral input system (experimental).#NEWLINE#help       Show basic help text.#NEWLINE#output     Change numeral output system (experimental).#NEWLINE#list       Show content of a directory.#NEWLINE#show       Show content of a file.#NEWLINE#load       Load variable and functions from file.#NEWLINE#save       Save variable and functions to file.#NEWLINE#variables  Show list of variables.#NEWLINE#version    Show version string.#NEWLINE#memory     Show internal memory usage.#NEWLINE#exit       Exit program.#NEWLINE#---------------------------------------------------------#NEWLINE#The def and eval statements are optional. Functions and#NEWLINE#variables statements can be shorten to funcs and vars.#NEWLINE#

  53. ; Help for complex numbers

  54. symcomplex (/200/)

  55. Expressions with complex numbers are written using an i to denote#NEWLINE#the imaginary value. Complex numbers can seamlessly be mixed with#NEWLINE#real numbers.#NEWLINE##SYNTAXHIGHLIGHT#Syntax:  2+3i#NEWLINE#Example: 2+3.2i*cos(-1i)+5/7#NEWLINE#

  56. ; Help for clear statement

  57. symclear (/40/)

  58. The clear statement erases all text in the console window.#NEWLINE##SYNTAXHIGHLIGHT#Syntax: clear#NEWLINE#

  59. ; Help for def statement

  60. symdef (/200/)

  61. The def statement is used to define functions. When defining a function#NEWLINE#it is possible to omit the def keyword. Defined functions can be shown#NEWLINE#using the functions statement.#NEWLINE##SYNTAXHIGHLIGHT#Syntax: def f(x)=2*x+3#NEWLINE#Optional syntax: f(x)=2*x+3#NEWLINE#

  62. ; Help for delete statement

  63. symdelete (/250/)

  64. The delete statement can delete variable and functions. To delete a#NEWLINE#single variable or functions use the name of the function or variable.#NEWLINE#To delete all functions or variables specify either the variable or#NEWLINE#function keyword.#NEWLINE##SYNTAXHIGHLIGHT#Syntax: delete f(x)#NEWLINE#Syntax: delete variables#NEWLINE#

  65. ; Help for digits statement

  66. symdigits (/150/) 

  67. The digits statement defines the displayed number of significant digits.#NEWLINE#To show current configuration use the digits statement without specifying#NEWLINE#the number.#NEWLINE# #SYNTAXHIGHLIGHT#Syntax: digits 7#NEWLINE#

  68. ; Help for eval statement

  69. symeval (/80/)

  70. The eval statement evaluates an expression. When evaluating an expression#NEWLINE#it is possible to omit the eval keyword.#NEWLINE##SYNTAXHIGHLIGHT#Syntax: eval 2.4*x+3.2#NEWLINE#Optional syntax: 2.4*x+3.2#NEWLINE#

  71. ; Help for execute statement

  72. symexecute (/40/)

  73. The execute statement reads the content of a file and execute all statements.#NEWLINE##SYNTAXHIGHLIGHT#Syntax: execute "savedfile"#NEWLINE#

  74. ; Help for input statement

  75. syminput (/120/)

  76. The input statement either changes or shows the how numeral input is interpreted.#NEWLINE#Possible input systems are: binary, octal, decimal and hexadecimal. Default is#NEWLINE#decimal. To use positional systems with other bases specify the base number.#NEWLINE#Numeral output system can be modified using the output statement.#NEWLINE##SYNTAXHIGHLIGHT#Syntax: input hexadecimal#NEWLINE#Syntax: input 4#NEWLINE#

  77. ; Help for help statement

  78. symhelp (/50/)

  79. The help statement can be used to display help about topics and statements.#NEWLINE##SYNTAXHIGHLIGHT#Syntax: help variables#NEWLINE#

  80. ; Help for output statement

  81. symoutput (/120/)

  82. The output statement either changes or shows the how numeral output is shown.#NEWLINE#Possible output systems are: binary, octal, decimal and hexadecimal. Default#NEWLINE#is decimal. To use positional systems with other bases specify the base number.#NEWLINE#Numeral input system can be modified using the input statement.#NEWLINE##SYNTAXHIGHLIGHT#Syntax: output octal#NEWLINE#

  83. ; Help for list statement

  84. symlist (/40/)

  85. No description is available for the list statement.#NEWLINE#

  86. ; Help for show statement

  87. symshow (/40/)

  88. The show statement displays the content of a file.#NEWLINE##SYNTAXHIGHLIGHT#Syntax: show "filetosee"#NEWLINE#

  89. ; Help for load statement

  90. symload (/80/)

  91. The load statement retrieves a set of defined variables and functions from#NEWLINE#a file. Variables and functions can be saved using the save statement.#NEWLINE##SYNTAXHIGHLIGHT#Syntax: load "savedwork"#NEWLINE#

  92. ; Help for save statement

  93. symsave (/80/)

  94. The save statement saves defined variables and functions to a file in a#NEWLINE#plain text format. Saved variables and functions can be retrieved using#NEWLINE#the load statement.#NEWLINE# #SYNTAXHIGHLIGHT#Syntax: save "worktokeep"#NEWLINE#

  95. ; Help for version statement

  96. symversion (/40/)

  97. Show which version of amath is running.#NEWLINE#

  98. ; Help for memory statement

  99. symmem (/40/)

  100. Show internal memory usage together with maximum usage.#NEWLINE#

  101. ; Help for prefs statement

  102. symprefs (/40/)

  103. There is no help for prefs statement now.#NEWLINE#

  104. ; Help for variable statement

  105. symvariable (/40/)

  106. The variable statement shows a list of variables in memory.#NEWLINE##SYNTAXHIGHLIGHT#Syntax: variables#NEWLINE##NORMALTEXT#optional syntax: vars#NEWLINE#

  107. ; Help for exit statement

  108. symexit (/40/)

  109. The exit statement shuts down amath.#NEWLINE##SYNTAXHIGHLIGHT#Syntax: exit#NEWLINE#

  110. ; Help for constant epsilon

  111. syme (/40/)

  112. Euler's number is base of the exponential function which equals its own#NEWLINE#derivative. It is approximately equal to 2.71828.#NEWLINE##SYNTAXHIGHLIGHT#Example: ln(e)#NEWLINE#

  113. ; Help for constant pi

  114. sympi (/40/)

  115. Pi is the ratio of the circumference of a circle to its diameter. Being an#NEWLINE#irrational number, pi cannot be expressed exactly as a common fraction.#NEWLINE#The value of pi is commonly approximated as #SYNTAXHIGHLIGHT#3.14159#NORMALTEXT#.#NEWLINE#

  116. ; Help for imaginary unit

  117. symi (/40/)

  118. The imaginary unit is denoted and commonly referred to as i.#NEWLINE#The imaginary unit is a number, which when multiplied#NEWLINE#by itself gives -1.#NEWLINE#

  119. ; Help for ins variable

  120. symins (/40/)

  121. No help is available for the ins variable#NEWLINE#

  122. ; Help for binary keyword

  123. symbin (/40/)

  124. No help is available for the binary keyword#NEWLINE

  125. ; Help for octal keyword

  126. symoct (/40/)

  127. No help is available for the octal keyword#NEWLINE

  128. ; Help for decimal keyword

  129. symdec (/40/)

  130. No help is available for the decimal keyword#NEWLINE

  131. ; Help for hexadecimal keyword

  132. symhex (/40/)

  133. No help is available for the hexadecimal keyword#NEWLINE