1<?xml version="1.0" encoding="UTF-8"?> 2 3 4<!--*********************************************************** 5 * 6 * Licensed to the Apache Software Foundation (ASF) under one 7 * or more contributor license agreements. See the NOTICE file 8 * distributed with this work for additional information 9 * regarding copyright ownership. The ASF licenses this file 10 * to you under the Apache License, Version 2.0 (the 11 * "License"); you may not use this file except in compliance 12 * with the License. You may obtain a copy of the License at 13 * 14 * http://www.apache.org/licenses/LICENSE-2.0 15 * 16 * Unless required by applicable law or agreed to in writing, 17 * software distributed under the License is distributed on an 18 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 19 * KIND, either express or implied. See the License for the 20 * specific language governing permissions and limitations 21 * under the License. 22 * 23 ***********************************************************--> 24 25 26 27<helpdocument version="1.0"> 28<meta> 29<topic id="textsbasicshared03080701xml" indexer="include" status="PUBLISH"> 30<title id="tit" xml-lang="en-US">Sgn Function [Runtime]</title> 31<filename>/text/sbasic/shared/03080701.xhp</filename> 32</topic> 33<history> 34<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> 35<lastedited date="2004-08-24T14:24:24">converted from old format - fpe</lastedited> 36</history> 37</meta> 38<body> 39<section id="sgn"> 40<bookmark xml-lang="en-US" branch="index" id="bm_id3148474"><bookmark_value>Sgn function</bookmark_value> 41</bookmark> 42<paragraph role="heading" id="hd_id3148474" xml-lang="en-US" level="1" l10n="U" oldref="1"><link href="text/sbasic/shared/03080701.xhp" name="Sgn Function [Runtime]">Sgn Function [Runtime]</link></paragraph> 43<paragraph role="paragraph" id="par_id3148686" xml-lang="en-US" l10n="U" oldref="2">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> 44</section> 45<paragraph role="heading" id="hd_id3156023" xml-lang="en-US" level="2" l10n="U" oldref="3">Syntax:</paragraph> 46<paragraph role="paragraph" id="par_id3153897" xml-lang="en-US" l10n="U" oldref="4">Sgn (Number)</paragraph> 47<paragraph role="heading" id="hd_id3145069" xml-lang="en-US" level="2" l10n="U" oldref="5">Return value:</paragraph> 48<paragraph role="paragraph" id="par_id3150359" xml-lang="en-US" l10n="U" oldref="6">Integer</paragraph> 49<paragraph role="heading" id="hd_id3150543" xml-lang="en-US" level="2" l10n="U" oldref="7">Parameters:</paragraph> 50<paragraph role="paragraph" id="par_id3154365" xml-lang="en-US" l10n="U" oldref="8"> 51<emph>Number:</emph> Numeric expression that determines the value that is returned by the function.</paragraph> 52<table id="tbl_id3156281"> 53<tablerow> 54<tablecell colspan="" rowspan=""> 55<paragraph role="paragraph" id="par_id3150767" xml-lang="en-US" l10n="U" oldref="9">NumExpression</paragraph> 56</tablecell> 57<tablecell colspan="" rowspan=""> 58<paragraph role="paragraph" id="par_id3150441" xml-lang="en-US" l10n="U" oldref="10">Return value</paragraph> 59</tablecell> 60</tablerow> 61<tablerow> 62<tablecell colspan="" rowspan=""> 63<paragraph role="paragraph" id="par_id3161833" xml-lang="en-US" l10n="U" oldref="11">negative</paragraph> 64</tablecell> 65<tablecell colspan="" rowspan=""> 66<paragraph role="paragraph" id="par_id3155306" xml-lang="en-US" l10n="U" oldref="12">Sgn returns -1.</paragraph> 67</tablecell> 68</tablerow> 69<tablerow> 70<tablecell colspan="" rowspan=""> 71<paragraph role="paragraph" id="par_id3145271" xml-lang="en-US" l10n="U" oldref="13">0</paragraph> 72</tablecell> 73<tablecell colspan="" rowspan=""> 74<paragraph role="paragraph" id="par_id3146119" xml-lang="en-US" l10n="U" oldref="14">Sgn returns 0.</paragraph> 75</tablecell> 76</tablerow> 77<tablerow> 78<tablecell colspan="" rowspan=""> 79<paragraph role="paragraph" id="par_id3153139" xml-lang="en-US" l10n="U" oldref="15">positive</paragraph> 80</tablecell> 81<tablecell colspan="" rowspan=""> 82<paragraph role="paragraph" id="par_id3154319" xml-lang="en-US" l10n="U" oldref="16">Sgn returns 1.</paragraph> 83</tablecell> 84</tablerow> 85</table> 86<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> 87<embed href="text/sbasic/shared/00000003.xhp#err5"/> 88<paragraph role="heading" id="hd_id3152576" xml-lang="en-US" level="2" l10n="U" oldref="17">Example:</paragraph> 89<paragraph role="paragraph" id="par_id3154791" xml-lang="en-US" l10n="U" oldref="18">Sub ExampleSgn</paragraph> 90<paragraph role="paragraph" id="par_id3155416" xml-lang="en-US" l10n="U" oldref="19">Print sgn(-10) REM returns -1</paragraph> 91<paragraph role="paragraph" id="par_id3154096" xml-lang="en-US" l10n="U" oldref="20">Print sgn(0) REM returns 0</paragraph> 92<paragraph role="paragraph" id="par_id3148457" xml-lang="en-US" l10n="U" oldref="21">Print sgn(10) REM returns 1</paragraph> 93<paragraph role="paragraph" id="par_id3144765" xml-lang="en-US" l10n="U" oldref="22">end sub</paragraph> 94</body> 95</helpdocument> 96