summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlain Romedenne <alain.romedenne@libreoffice.org>2021-11-10 16:13:38 +0200
committerOlivier Hallot <olivier.hallot@libreoffice.org>2021-11-10 20:22:21 +0100
commitb902fbcc87b0baf76b3dd501f0feff40bb1f3711 (patch)
treed0823b39520bc20cb6a167f69c80836cd77d7e21
parent858f7cac7f8fc3ec21c2273c21f7a4b34c608d62 (diff)
tdf#141474 Atn, Cos, Sin, Tan function signatures
xxx(number As Double) As Double Change-Id: Ibf1020ba6027d0f30b3c0a5609c407bbef6660d2 Reviewed-on: https://gerrit.libreoffice.org/c/help/+/124967 Tested-by: Jenkins Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
-rw-r--r--source/text/sbasic/shared/03080101.xhp22
-rw-r--r--source/text/sbasic/shared/03080102.xhp29
-rw-r--r--source/text/sbasic/shared/03080103.xhp34
-rw-r--r--source/text/sbasic/shared/03080104.xhp32
4 files changed, 70 insertions, 47 deletions
diff --git a/source/text/sbasic/shared/03080101.xhp b/source/text/sbasic/shared/03080101.xhp
index af0a6db97a..8a480a5e19 100644
--- a/source/text/sbasic/shared/03080101.xhp
+++ b/source/text/sbasic/shared/03080101.xhp
@@ -30,25 +30,25 @@
<bookmark xml-lang="en-US" branch="index" id="bm_id3150616">
<bookmark_value>Atn function</bookmark_value>
</bookmark>
- <paragraph id="hd_id3150616" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03080101.xhp" name="Atn Function">Atn Function</link></paragraph>
- <paragraph id="par_id3149346" role="paragraph" xml-lang="en-US">Trigonometric function that returns the arctangent of a numeric expression. The return value is in the range -Pi/2 to +Pi/2.</paragraph>
+ <h1 id="hd_id3150616"><variable id="Atn_h1"><link href="text/sbasic/shared/03080101.xhp" name="Atn Function">Atn Function</link></variable></h1>
+ <paragraph id="par_id3149346" role="paragraph">Trigonometric function that returns the arctangent of a numeric expression. The return value is in the range -Pi/2 to +Pi/2.</paragraph>
</section>
- <paragraph id="par_id3143271" role="paragraph" xml-lang="en-US">The arctangent is the inverse of the tangent function. The Atn Function returns the angle "Alpha", expressed in radians, using the tangent of this angle. The function can also return the angle "Alpha" by comparing the ratio of the length of the side that is opposite of the angle to the length of the side that is adjacent to the angle in a right-angled triangle.</paragraph>
- <paragraph id="par_id3145315" role="paragraph" xml-lang="en-US">Atn(side opposite the angle/side adjacent to angle)= Alpha</paragraph>
+ <paragraph id="par_id3143271" role="paragraph" xml-lang="en-US">The arctangent is the inverse of the tangent function. The <literal>Atn</literal> Function returns the angle "Alpha", expressed in radians, using the tangent of this angle. The function can also return the angle "Alpha" by comparing the ratio of the length of the side that is opposite of the angle to the length of the side that is adjacent to the angle in a right-angled triangle.</paragraph>
+ <paragraph id="par_id3145315" role="paragraph" xml-lang="en-US"><literal>Atn</literal>(side opposite the angle/side adjacent to angle)= Alpha</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
<bascode>
- <paragraph id="par_id3148947" role="bascode" xml-lang="en-US">Atn (Number)</paragraph>
+ <paragraph id="par_id3148947" role="bascode" xml-lang="en-US">Atn (Number As Double) As Double</paragraph>
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#functvalue"/>
<paragraph id="par_id3150359" role="paragraph" xml-lang="en-US">Double</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functparameters"/>
- <paragraph id="par_id3156212" role="paragraph" xml-lang="en-US"> <emph>Number:</emph> Any numerical expression that represents the ratio of two sides of a right triangle. The Atn function returns the corresponding angle in radians (arctangent).</paragraph>
+ <paragraph id="par_id3156212" role="paragraph" xml-lang="en-US"> <emph>Number:</emph> Any numerical expression that represents the ratio of two sides of a right triangle. The <literal>Atn</literal> function returns the corresponding angle in radians (arctangent).</paragraph>
<paragraph id="par_id3153192" role="paragraph" xml-lang="en-US">To convert radians to degrees, multiply radians by 180/pi.</paragraph>
<paragraph id="par_id3147230" role="paragraph" xml-lang="en-US">degree=(radian*180)/pi</paragraph>
<paragraph id="par_id3125864" role="paragraph" xml-lang="en-US">radian=(degree*pi)/180</paragraph>
- <paragraph id="par_id3159252" role="paragraph" xml-lang="en-US">Pi is here the fixed circle constant with the rounded value 3.14159. Pi is a <link href="text/sbasic/shared/03040000.xhp#mathconstants" name="pi">Basic mathematical constant</link>.</paragraph>
+ <paragraph id="par_id3159252" role="paragraph" xml-lang="en-US"><literal>Pi</literal> is here the fixed circle constant with the rounded value 3.14159. <literal>Pi</literal> is a <link href="text/sbasic/shared/03040000.xhp#mathconstants" name="pi">Basic mathematical constant</link>.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
<embed href="text/sbasic/shared/00000003.xhp#err5"/>
@@ -65,6 +65,12 @@
<paragraph id="par_id3155415" role="bascode" xml-lang="en-US"> Print "The Alpha angle is"; (atn (d2/d1) * 180 / Pi); " degrees"</paragraph>
<paragraph id="par_idm1340859728" role="bascode" localize="false">End Sub</paragraph>
</bascode>
-</body>
+<section id="relatedtopics">
+ <embed href="text/sbasic/shared/03080102.xhp#Cos_h1"/>
+ <embed href="text/sbasic/shared/03080103.xhp#Sin_h1"/>
+ <embed href="text/sbasic/shared/03080104.xhp#Tan_h1"/>
+</section>
+
+</body>
</helpdocument>
diff --git a/source/text/sbasic/shared/03080102.xhp b/source/text/sbasic/shared/03080102.xhp
index 908daeec3c..ba199bf3bc 100644
--- a/source/text/sbasic/shared/03080102.xhp
+++ b/source/text/sbasic/shared/03080102.xhp
@@ -34,30 +34,29 @@
</bookmark>
-<paragraph id="hd_id3154923" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03080102.xhp" name="Cos Function">Cos Function</link></paragraph>
-<paragraph id="par_id3159413" role="paragraph" xml-lang="en-US">Calculates the cosine of an angle. The angle is specified in radians. The result lies between -1 and 1.</paragraph>
+<h1 id="hd_id3154923"><variable id="Cos_h1"><link href="text/sbasic/shared/03080102.xhp" name="Cos Function">Cos Function</link></variable></h1>
+<paragraph id="par_id3159413" role="paragraph">Calculates the cosine of an angle. The angle is specified in radians. The result lies between -1 and 1.</paragraph>
</section>
-<paragraph id="par_id3150358" role="paragraph" xml-lang="en-US">Using the angle Alpha, the Cos-Function calculates the ratio of the length of the side that is adjacent to the angle, divided by the length of the hypotenuse in a right-angled triangle.</paragraph>
-<paragraph id="par_id3154141" role="paragraph" xml-lang="en-US">Cos(Alpha) = Adjacent/Hypotenuse</paragraph>
+<paragraph id="par_id3150358" role="paragraph" xml-lang="en-US">Using the angle Alpha, the <literal>Cos</literal> function calculates the ratio of the length of the side that is adjacent to the angle, divided by the length of the hypotenuse in a right-angled triangle.</paragraph>
+<paragraph id="par_id3154141" role="paragraph" xml-lang="en-US"><literal>Cos</literal>(Alpha) = Adjacent/Hypotenuse</paragraph>
-<paragraph id="hd_id3154125" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph>
-<bascode>
-<paragraph id="par_id3145172" role="bascode" xml-lang="en-US">Cos (Number)</paragraph>
+<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/><bascode>
+<paragraph id="par_id3145172" role="bascode" xml-lang="en-US">Cos (Number As Double) As Double</paragraph>
</bascode>
-<paragraph id="hd_id3156214" role="heading" level="2" xml-lang="en-US">Return value:</paragraph>
+<embed href="text/sbasic/shared/00000003.xhp#functvalue"/>
<paragraph id="par_id3150449" role="paragraph" xml-lang="en-US">Double</paragraph>
-<paragraph id="hd_id3153969" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph>
+<embed href="text/sbasic/shared/00000003.xhp#functparameters"/>
<paragraph id="par_id3153770" role="paragraph" xml-lang="en-US"> <emph>Number:</emph> Numeric expression that specifies an angle in radians that you want to calculate the cosine for.</paragraph>
<paragraph id="par_id3145749" role="paragraph" xml-lang="en-US">To convert degrees to radians, multiply degrees by pi/180. To convert radians to degrees, multiply radians by 180/pi.</paragraph>
<paragraph id="par_id3149664" role="paragraph" xml-lang="en-US">degree=(radian*180)/pi</paragraph>
<paragraph id="par_id3146985" role="paragraph" xml-lang="en-US">radian=(degree*pi)/180</paragraph>
-<paragraph id="par_id3152885" role="paragraph" xml-lang="en-US">Pi is here the fixed circle constant with the rounded value 3.14159...</paragraph>
+<paragraph id="par_id3152885" role="paragraph" xml-lang="en-US"><literal>Pi</literal> is here the fixed circle constant with the rounded value 3.14159...</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
<embed href="text/sbasic/shared/00000003.xhp#err5"/>
-<paragraph id="hd_id3153951" role="heading" level="2" xml-lang="en-US">Example:</paragraph>
+<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<bascode>
<paragraph id="par_id3155855" role="bascode" xml-lang="en-US">' The following example allows for a right-angled triangle the input of</paragraph>
<paragraph id="par_id3149484" role="bascode" xml-lang="en-US">' secant and angle (in degrees) and calculates the length of the hypotenuse:</paragraph>
@@ -69,6 +68,12 @@
<paragraph id="par_id3151074" role="bascode" xml-lang="en-US"> Print "The length of the hypothenuse is"; (d1 / cos (dAngle * Pi / 180))</paragraph>
<paragraph id="par_idm1341552832" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph>
</bascode>
-</body>
+<section id="relatedtopics">
+ <embed href="text/sbasic/shared/03080101.xhp#Atn_h1"/>
+ <embed href="text/sbasic/shared/03080103.xhp#Sin_h1"/>
+ <embed href="text/sbasic/shared/03080104.xhp#Tan_h1"/>
+</section>
+
+</body>
</helpdocument> \ No newline at end of file
diff --git a/source/text/sbasic/shared/03080103.xhp b/source/text/sbasic/shared/03080103.xhp
index bc3a81c2b9..ff97900031 100644
--- a/source/text/sbasic/shared/03080103.xhp
+++ b/source/text/sbasic/shared/03080103.xhp
@@ -34,30 +34,30 @@
</bookmark>
-<paragraph id="hd_id3153896" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03080103.xhp" name="Sin Function">Sin Function</link></paragraph>
-<paragraph id="par_id3149456" role="paragraph" xml-lang="en-US">Returns the sine of an angle. The angle is specified in radians. The result lies between -1 and 1.</paragraph>
+<h1 id="hd_id3153896"><variable id="Sin_h1"><link href="text/sbasic/shared/03080103.xhp" name="Sin Function">Sin Function</link></variable></h1>
+<paragraph id="par_id3149456" role="paragraph">Returns the sine of an angle. The angle is specified in radians. The result lies between -1 and 1.</paragraph>
</section>
-<paragraph id="par_id3153379" role="paragraph" xml-lang="en-US">Using the angle Alpha, the Sin Function returns the ratio of the length of the opposite side of an angle to the length of the hypotenuse in a right-angled triangle.</paragraph>
-<paragraph id="par_id3148798" role="paragraph" xml-lang="en-US">Sin(Alpha) = side opposite the angle/hypotenuse</paragraph>
+<paragraph id="par_id3153379" role="paragraph" xml-lang="en-US">Using the angle Alpha, the <literal>Sin</literal> function returns the ratio of the length of the opposite side of an angle to the length of the hypotenuse in a right-angled triangle.</paragraph>
+<paragraph id="par_id3148798" role="paragraph" xml-lang="en-US"><literal>Sin</literal>(Alpha) = side opposite the angle/hypotenuse</paragraph>
-<paragraph id="hd_id3147230" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph>
+<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
<bascode>
-<paragraph id="par_id3154909" role="bascode" xml-lang="en-US">Sin (Number)</paragraph>
+<paragraph id="par_id3154909" role="bascode" xml-lang="en-US">Sin (Number As Double) As Double</paragraph>
</bascode>
-<paragraph id="hd_id3156214" role="heading" level="2" xml-lang="en-US">Return value:</paragraph>
+<embed href="text/sbasic/shared/00000003.xhp#functvalue"/>
<paragraph id="par_id3150870" role="paragraph" xml-lang="en-US">Double</paragraph>
-<paragraph id="hd_id3155132" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph>
+<embed href="text/sbasic/shared/00000003.xhp#functparameters"/>
<paragraph id="par_id3145786" role="paragraph" xml-lang="en-US"> <emph>Number:</emph> Numeric expression that defines the angle in radians that you want to calculate the sine for.</paragraph>
-<paragraph id="par_id3155413" role="paragraph" xml-lang="en-US">To convert degrees to radians, multiply degrees by Pi/180, and to convert radians to degrees, multiply radians by 180/Pi.</paragraph>
-<paragraph id="par_id3149664" role="paragraph" xml-lang="en-US">grad=(radiant*180)/pi</paragraph>
-<paragraph id="par_id3153143" role="paragraph" xml-lang="en-US">radiant=(grad*pi)/180</paragraph>
-<paragraph id="par_id3151112" role="paragraph" xml-lang="en-US">Pi is approximately 3.141593.</paragraph>
+<paragraph id="par_id3155413" role="paragraph" xml-lang="en-US">To convert degrees to radians, multiply degrees by <literal>Pi</literal>/180, and to convert radians to degrees, multiply radians by 180/<literal>Pi</literal>.</paragraph>
+<paragraph id="par_id3149664" role="paragraph" xml-lang="en-US">grad=(radiant*180)/<literal>Pi</literal></paragraph>
+<paragraph id="par_id3153143" role="paragraph" xml-lang="en-US">radiant=(grad*<literal>Pi</literal>)/180</paragraph>
+<paragraph id="par_id3151112" role="paragraph" xml-lang="en-US"><literal>Pi</literal> is approximately 3.141593.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
<embed href="text/sbasic/shared/00000003.xhp#err5"/>
-<paragraph id="hd_id3163712" role="heading" level="2" xml-lang="en-US">Example:</paragraph>
+<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<bascode>
<paragraph id="par_id3149482" role="bascode" xml-lang="en-US">' In this example, the following entry is possible for a right-angled triangle:</paragraph>
<paragraph id="par_id3148577" role="bascode" xml-lang="en-US">' The side opposite the angle and the angle (in degrees) to calculate the length of the hypotenuse:</paragraph>
@@ -70,6 +70,12 @@
<paragraph id="par_id3153877" role="bascode" xml-lang="en-US"> Print "The length of the hypotenuse is"; (d1 / sin (dAlpha * Pi / 180))</paragraph>
<paragraph id="par_idm1341551616" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph>
</bascode>
-</body>
+<section id="relatedtopics">
+ <embed href="text/sbasic/shared/03080101.xhp#Atn_h1"/>
+ <embed href="text/sbasic/shared/03080102.xhp#Cos_h1"/>
+ <embed href="text/sbasic/shared/03080104.xhp#Tan_h1"/>
+</section>
+
+</body>
</helpdocument> \ No newline at end of file
diff --git a/source/text/sbasic/shared/03080104.xhp b/source/text/sbasic/shared/03080104.xhp
index 2fe6d71596..194fa0901b 100644
--- a/source/text/sbasic/shared/03080104.xhp
+++ b/source/text/sbasic/shared/03080104.xhp
@@ -34,30 +34,30 @@
</bookmark>
-<paragraph id="hd_id3148550" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03080104.xhp" name="Tan Function">Tan Function</link></paragraph>
+<h1 id="hd_id3148550"><variable id="Tan_h1"><link href="text/sbasic/shared/03080104.xhp" name="Tan Function">Tan Function</link></variable></h1>
<paragraph id="par_id3148663" role="paragraph" xml-lang="en-US">Determines the tangent of an angle. The angle is specified in radians.<comment>i71396</comment></paragraph>
</section>
-<paragraph id="par_id3153379" role="paragraph" xml-lang="en-US">Using the angle Alpha, the Tan Function calculates the ratio of the length of the side opposite the angle to the length of the side adjacent to the angle in a right-angled triangle.</paragraph>
-<paragraph id="par_id3154366" role="paragraph" xml-lang="en-US">Tan(Alpha) = side opposite the angle/side adjacent to angle</paragraph>
+<paragraph id="par_id3153379" role="paragraph" xml-lang="en-US">Using the angle Alpha, the <literal>Tan</literal> function calculates the ratio of the length of the side opposite the angle to the length of the side adjacent to the angle in a right-angled triangle.</paragraph>
+<paragraph id="par_id3154366" role="paragraph" xml-lang="en-US"><literal>Tan</literal>(Alpha) = side opposite the angle/side adjacent to angle</paragraph>
-<paragraph id="hd_id3145174" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph>
+<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
<bascode>
-<paragraph id="par_id3151042" role="bascode" xml-lang="en-US">Tan (Number)</paragraph>
+<paragraph id="par_id3151042" role="bascode" xml-lang="en-US">Tan (Number As Double) As Double</paragraph>
</bascode>
-<paragraph id="hd_id3156214" role="heading" level="2" xml-lang="en-US">Return value:</paragraph>
+<embed href="text/sbasic/shared/00000003.xhp#functvalue"/>
<paragraph id="par_id3156281" role="paragraph" xml-lang="en-US">Double</paragraph>
-<paragraph id="hd_id3155132" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph>
+<embed href="text/sbasic/shared/00000003.xhp#functparameters"/>
<paragraph id="par_id3145786" role="paragraph" xml-lang="en-US"> <emph>Number:</emph> Any numeric expression that you want to calculate the tangent for (in radians).</paragraph>
-<paragraph id="par_id3153728" role="paragraph" xml-lang="en-US">To convert degrees to radians, multiply by Pi/180. To convert radians to degrees, multiply by 180/Pi.</paragraph>
-<paragraph id="par_id3155414" role="paragraph" xml-lang="en-US">degrees=(radiant*180)/Pi</paragraph>
-<paragraph id="par_id3146975" role="paragraph" xml-lang="en-US">radiant=(degrees*Pi)/180</paragraph>
-<paragraph id="par_id3147434" role="paragraph" xml-lang="en-US">Pi is approximately 3.141593.</paragraph>
+<paragraph id="par_id3153728" role="paragraph" xml-lang="en-US">To convert degrees to radians, multiply by <literal>Pi</literal>/180. To convert radians to degrees, multiply by 180/<literal>Pi</literal>.</paragraph>
+<paragraph id="par_id3155414" role="paragraph" xml-lang="en-US">degrees=(radiant*180)/<literal>Pi</literal></paragraph>
+<paragraph id="par_id3146975" role="paragraph" xml-lang="en-US">radiant=(degrees*<literal>Pi</literal>)/180</paragraph>
+<paragraph id="par_id3147434" role="paragraph" xml-lang="en-US"><literal>Pi</literal> is approximately 3.141593.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
<embed href="text/sbasic/shared/00000003.xhp#err5"/>
-<paragraph id="hd_id3149483" role="heading" level="2" xml-lang="en-US">Example:</paragraph>
+<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<bascode>
<paragraph id="par_id3148646" role="bascode" xml-lang="en-US">' In this example, the following entry is possible for a right-angled triangle:</paragraph>
<paragraph id="par_id3150012" role="bascode" xml-lang="en-US">' The side opposite the angle and the angle (in degrees) to calculate the length of the side adjacent to the angle:</paragraph>
@@ -70,6 +70,12 @@
<paragraph id="par_id3154016" role="bascode" xml-lang="en-US"> Print "the length of the side adjacent the angle is"; (d1 / tan (dAlpha * Pi / 180))</paragraph>
<paragraph id="par_idm1340775872" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph>
</bascode>
-</body>
+<section id="relatedtopics">
+ <embed href="text/sbasic/shared/03080101.xhp#Atn_h1"/>
+ <embed href="text/sbasic/shared/03080102.xhp#Cos_h1"/>
+ <embed href="text/sbasic/shared/03080103.xhp#Sin_h1"/>
+</section>
+
+</body>
</helpdocument> \ No newline at end of file