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