| <?xml version="1.0" encoding="UTF-8"?> |
| |
| <!--*********************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| ***********************************************************--> |
| |
| <helpdocument version="1.0"> |
| <meta> |
| <topic id="textsbasicshared03080701xml" indexer="include" status="PUBLISH"> |
| <title id="tit" xml-lang="en-US">Sgn Function [Runtime]</title> |
| <filename>/text/sbasic/shared/03080701.xhp</filename> |
| </topic> |
| </meta> |
| <body> |
| <section id="sgn"> |
| <bookmark xml-lang="en-US" branch="index" id="bm_id3148474"> |
| <bookmark_value>Sgn function</bookmark_value> |
| </bookmark> |
| <paragraph role="heading" id="hd_id3148474" xml-lang="en-US" level="1" l10n="U"><link href="text/sbasic/shared/03080701.xhp" name="Sgn Function [Runtime]">Sgn Function [Runtime]</link></paragraph> |
| <paragraph role="paragraph" id="par_id3148686" xml-lang="en-US" l10n="U">Returns an integer number between -1 and 1 that indicates if the number that is passed to the function is positive, negative, or zero.</paragraph> |
| </section> |
| <paragraph role="heading" id="hd_id3156023" xml-lang="en-US" level="2" l10n="U">Syntax:</paragraph> |
| <paragraph role="paragraph" id="par_id3153897" xml-lang="en-US" l10n="U">Sgn (Number)</paragraph> |
| <paragraph role="heading" id="hd_id3145069" xml-lang="en-US" level="2" l10n="U">Return value:</paragraph> |
| <paragraph role="paragraph" id="par_id3150359" xml-lang="en-US" l10n="U">Integer</paragraph> |
| <paragraph role="heading" id="hd_id3150543" xml-lang="en-US" level="2" l10n="U">Parameters:</paragraph> |
| <paragraph role="paragraph" id="par_id3154365" xml-lang="en-US" l10n="U"><emph>Number:</emph> Numeric expression that determines the value that is returned by the function.</paragraph> |
| <table id="tbl_id3156281"> |
| <tablerow> |
| <tablecell colspan="" rowspan=""> |
| <paragraph role="paragraph" id="par_id3150767" xml-lang="en-US" l10n="U">NumExpression</paragraph> |
| </tablecell> |
| <tablecell colspan="" rowspan=""> |
| <paragraph role="paragraph" id="par_id3150441" xml-lang="en-US" l10n="U">Return value</paragraph> |
| </tablecell> |
| </tablerow> |
| <tablerow> |
| <tablecell colspan="" rowspan=""> |
| <paragraph role="paragraph" id="par_id3161833" xml-lang="en-US" l10n="U">negative</paragraph> |
| </tablecell> |
| <tablecell colspan="" rowspan=""> |
| <paragraph role="paragraph" id="par_id3155306" xml-lang="en-US" l10n="U">Sgn returns -1.</paragraph> |
| </tablecell> |
| </tablerow> |
| <tablerow> |
| <tablecell colspan="" rowspan=""> |
| <paragraph role="paragraph" id="par_id3145271" xml-lang="en-US" l10n="U">0</paragraph> |
| </tablecell> |
| <tablecell colspan="" rowspan=""> |
| <paragraph role="paragraph" id="par_id3146119" xml-lang="en-US" l10n="U">Sgn returns 0.</paragraph> |
| </tablecell> |
| </tablerow> |
| <tablerow> |
| <tablecell colspan="" rowspan=""> |
| <paragraph role="paragraph" id="par_id3153139" xml-lang="en-US" l10n="U">positive</paragraph> |
| </tablecell> |
| <tablecell colspan="" rowspan=""> |
| <paragraph role="paragraph" id="par_id3154319" xml-lang="en-US" l10n="U">Sgn returns 1.</paragraph> |
| </tablecell> |
| </tablerow> |
| </table> |
| <embed href="text/sbasic/shared/00000003.xhp#errorcode"/> |
| <embed href="text/sbasic/shared/00000003.xhp#err5"/> |
| <paragraph role="heading" id="hd_id3152576" xml-lang="en-US" level="2" l10n="U">Example:</paragraph> |
| <paragraph role="paragraph" id="par_id3154791" xml-lang="en-US" l10n="U">Sub ExampleSgn</paragraph> |
| <paragraph role="paragraph" id="par_id3155416" xml-lang="en-US" l10n="U">Print sgn(-10) REM returns -1</paragraph> |
| <paragraph role="paragraph" id="par_id3154096" xml-lang="en-US" l10n="U">Print sgn(0) REM returns 0</paragraph> |
| <paragraph role="paragraph" id="par_id3148457" xml-lang="en-US" l10n="U">Print sgn(10) REM returns 1</paragraph> |
| <paragraph role="paragraph" id="par_id3144765" xml-lang="en-US" l10n="U">end sub</paragraph> |
| </body> |
| </helpdocument> |
