You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-commits@db.apache.org by dy...@apache.org on 2008/01/14 16:45:00 UTC

svn commit: r611832 - in /db/derby/docs/trunk/src/ref: refderby.ditamap rreffunccosh.dita rreffunccot.dita rreffuncrand.dita rreffuncrandom.dita rreffuncsign.dita rreffuncsinh.dita rreffunctanh.dita

Author: dyre
Date: Mon Jan 14 07:44:57 2008
New Revision: 611832

URL: http://svn.apache.org/viewvc?rev=611832&view=rev
Log:
DERBY-3297: Document SIGN, SQRT, RAND, RANDOM, COSH, COT, SINH and TANH functions.
Patch contributed by Thomas Nielsen
Patch file: d3297-doc-4.diff

Added:
    db/derby/docs/trunk/src/ref/rreffunccosh.dita   (with props)
    db/derby/docs/trunk/src/ref/rreffunccot.dita   (with props)
    db/derby/docs/trunk/src/ref/rreffuncrand.dita   (with props)
    db/derby/docs/trunk/src/ref/rreffuncrandom.dita   (with props)
    db/derby/docs/trunk/src/ref/rreffuncsign.dita   (with props)
    db/derby/docs/trunk/src/ref/rreffuncsinh.dita   (with props)
    db/derby/docs/trunk/src/ref/rreffunctanh.dita   (with props)
Modified:
    db/derby/docs/trunk/src/ref/refderby.ditamap

Modified: db/derby/docs/trunk/src/ref/refderby.ditamap
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/refderby.ditamap?rev=611832&r1=611831&r2=611832&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/refderby.ditamap (original)
+++ db/derby/docs/trunk/src/ref/refderby.ditamap Mon Jan 14 07:44:57 2008
@@ -227,6 +227,8 @@
 <topicref href="rrefbuiltchar.dita" navtitle="CHAR function"></topicref>
 <topicref href="rrefsqlj40899.dita" navtitle="Concatenation operator"></topicref>
 <topicref href="rreffunccos.dita" navtitle="COS function"></topicref>
+<topicref href="rreffunccosh.dita" navtitle="COSH function"></topicref>
+<topicref href="rreffunccot.dita" navtitle="COT function"></topicref>
 <topicref href="rrefsqlj38716.dita" navtitle="COUNT function"></topicref>
 <topicref href="rrefsqlj66113.dita" navtitle="COUNT(*) function"></topicref>
 <topicref href="rrefsqljcurrentdate.dita" navtitle="CURRENT DATE function">
@@ -267,15 +269,20 @@
 <topicref href="rrefcasenullif.dita" navtitle="NULLIF expressions"></topicref>
 <topicref href="rreffuncpi.dita" navtitle="PI function"></topicref>
 <topicref href="rreffuncradians.dita" navtitle="RADIANS function"></topicref>
+<topicref href="rreffuncrandom.dita" navtitle="RANDOM function"></topicref>
+<topicref href="rreffuncrand.dita" navtitle="RAND function"></topicref>
 <topicref href="rrefsqlj32613.dita" navtitle="RTRIM function"></topicref>
 <topicref href="rrefsecondfunc.dita" navtitle="SECOND function"></topicref>
 <topicref href="rrefsqlj25228.dita" navtitle="SESSION_USER function"></topicref>
+<topicref href="rreffuncsign.dita" navtitle="SIGN function"></topicref>
 <topicref href="rreffuncsin.dita" navtitle="SIN function"></topicref>
+<topicref href="rreffuncsinh.dita" navtitle="SINH function"></topicref>
 <topicref href="rrefbuiltsmallint.dita" navtitle="SMALLINT function"></topicref>
 <topicref href="rrefsqlj73147.dita" navtitle="SQRT function"></topicref>
 <topicref href="rrefsqlj93082.dita" navtitle="SUBSTR function"></topicref>
 <topicref href="rrefsqlj13083.dita" navtitle="SUM function"></topicref>
 <topicref href="rreffunctan.dita" navtitle="TAN function"></topicref>
+<topicref href="rreffunctanh.dita" navtitle="TANH function"></topicref>
 <topicref href="rreftimefunc.dita" navtitle="TIME function"></topicref>
 <topicref href="rreftimestampfunc.dita" navtitle="TIMESTAMP function"></topicref>
 <topicref href="rreftrimfunc.dita" navtitle="TRIM function"></topicref>

Added: db/derby/docs/trunk/src/ref/rreffunccosh.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rreffunccosh.dita?rev=611832&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rreffunccosh.dita (added)
+++ db/derby/docs/trunk/src/ref/rreffunccosh.dita Mon Jan 14 07:44:57 2008
@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="utf-8"?>
+ 
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
+<!-- 
+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.
+-->
+<reference id="rreffunccosh" xml:lang="en-us">
+<title>COSH function</title>
+<shortdesc>The COSH function returns the hyperbolic cosine of a specified number.</shortdesc>
+<prolog><metadata>
+<keywords><indexterm>COSH function</indexterm><indexterm>functions<indexterm>COSH</indexterm></indexterm>
+</keywords>
+</metadata></prolog>
+<refbody>
+<section> <p> The specified number is the angle, in radians, that you want the hyperbolic cosine for. The specified number must be a <xref href="rrefsqljdoubleprecision.dita#rrefsqljdoubleprecision">DOUBLE PRECISION</xref> number.  <ul>
+<li>If the specified number is NULL, the result of this function is NULL. </li>
+<li>If the specified number is zero (0), the result of this function is one (1.0). </li>
+</ul></p> </section>
+<refsyn><title>Syntax</title> <codeblock><b>COSH ( <varname>number</varname> )</b></codeblock> </refsyn>
+</refbody>
+</reference>

Propchange: db/derby/docs/trunk/src/ref/rreffunccosh.dita
------------------------------------------------------------------------------
    svn:eol-style = native

Added: db/derby/docs/trunk/src/ref/rreffunccot.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rreffunccot.dita?rev=611832&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rreffunccot.dita (added)
+++ db/derby/docs/trunk/src/ref/rreffunccot.dita Mon Jan 14 07:44:57 2008
@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="utf-8"?>
+ 
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
+<!-- 
+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.
+-->
+<reference id="rreffunccot" xml:lang="en-us">
+<title>COT function</title>
+<shortdesc>The COT function returns the cotangens of a specified number.</shortdesc>
+<prolog><metadata>
+<keywords><indexterm>COT function</indexterm><indexterm>functions<indexterm>COT</indexterm></indexterm>
+</keywords>
+</metadata></prolog>
+<refbody>
+<section> <p> The specified number is the angle, in radians, that you want the cotangens for. The specified number must be a <xref href="rrefsqljdoubleprecision.dita#rrefsqljdoubleprecision">DOUBLE PRECISION</xref> number.
+<ul>
+<li>If the specified number is NULL, the result of this function is NULL. </li>
+</ul></p> </section>
+<refsyn><title>Syntax</title> <codeblock><b>COT ( <varname>number</varname> )</b></codeblock> </refsyn>
+</refbody>
+</reference>

Propchange: db/derby/docs/trunk/src/ref/rreffunccot.dita
------------------------------------------------------------------------------
    svn:eol-style = native

Added: db/derby/docs/trunk/src/ref/rreffuncrand.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rreffuncrand.dita?rev=611832&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rreffuncrand.dita (added)
+++ db/derby/docs/trunk/src/ref/rreffuncrand.dita Mon Jan 14 07:44:57 2008
@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="utf-8"?>
+ 
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
+<!-- 
+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.
+-->
+<reference id="rreffuncrand" xml:lang="en-us">
+<title>RAND function</title>
+<shortdesc>The RAND function returns a random number given a seed number</shortdesc>
+<prolog><metadata>
+<keywords><indexterm>RAND function</indexterm><indexterm>functions<indexterm>RAND</indexterm></indexterm>
+</keywords>
+</metadata></prolog>
+<refbody>
+<section> <p>The RAND function returns a <xref href="rrefsqljdoubleprecision.dita#rrefsqljdoubleprecision">DOUBLE PRECISION</xref> number with positive sign, greater than or equal to zero (0), and less than one (1.0), given an <xref href="rrefsqlj10696.dita#rrefsqlj10696">INTEGER</xref> seed number. </p>
+</section>
+<refsyn><title>Syntax</title> 
+<codeblock><b>RAND( <varname>seed</varname> )</b></codeblock> 
+</refsyn>
+</refbody>
+</reference>

Propchange: db/derby/docs/trunk/src/ref/rreffuncrand.dita
------------------------------------------------------------------------------
    svn:eol-style = native

Added: db/derby/docs/trunk/src/ref/rreffuncrandom.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rreffuncrandom.dita?rev=611832&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rreffuncrandom.dita (added)
+++ db/derby/docs/trunk/src/ref/rreffuncrandom.dita Mon Jan 14 07:44:57 2008
@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="utf-8"?>
+ 
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
+<!-- 
+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.
+-->
+<reference id="rreffuncrandom" xml:lang="en-us">
+<title>RANDOM function</title>
+<shortdesc>The RANDOM function returns a random number.</shortdesc>
+<prolog><metadata>
+<keywords><indexterm>RANDOM function</indexterm><indexterm>functions<indexterm>RANDOM</indexterm></indexterm>
+</keywords>
+</metadata></prolog>
+<refbody>
+<section> <p>The RANDOM function returns a <xref href="rrefsqljdoubleprecision.dita#rrefsqljdoubleprecision">DOUBLE PRECISION</xref> number with positive sign, greater than or equal to zero (0), and less than one (1.0).</p>
+</section>
+<refsyn><title>Syntax</title> 
+<codeblock><b>RANDOM()</b></codeblock> 
+</refsyn>
+</refbody>
+</reference>

Propchange: db/derby/docs/trunk/src/ref/rreffuncrandom.dita
------------------------------------------------------------------------------
    svn:eol-style = native

Added: db/derby/docs/trunk/src/ref/rreffuncsign.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rreffuncsign.dita?rev=611832&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rreffuncsign.dita (added)
+++ db/derby/docs/trunk/src/ref/rreffuncsign.dita Mon Jan 14 07:44:57 2008
@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
+<!-- 
+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.
+-->
+<reference id="rreffuncsign" xml:lang="en-us">
+<title>SIGN function</title>
+<shortdesc>The SIGN function returns the sign of the specified number.</shortdesc>
+<prolog><metadata>
+<keywords><indexterm>SIGN function</indexterm><indexterm>functions<indexterm>SIGN</indexterm></indexterm>
+</keywords>
+</metadata></prolog>
+<refbody>
+<section> <p>The specified number is the number you want the sign of.
+The specified number must be a <xref href="rrefsqljdoubleprecision.dita#rrefsqljdoubleprecision">DOUBLE
+PRECISION</xref> number. </p>
+<p>The data type of the returned value is <xref href="rrefsqlj10696.dita#rrefsqlj10696">INTEGER</xref>.</p> 
+<ul>
+<li>If the specified number is NULL, the result of this function is NULL.</li>
+<li>If the specified number is zero (0), the result of this function is zero (0).</li>
+<li>If the specified number is greater than zero (0), the result of this function is plus one (+1).</li>
+<li>If the specified number is less than zero (0), the result of this function is minus one (-1).</li>
+</ul>
+</section>
+<refsyn><title>Syntax</title><codeblock><b>SIGN ( <varname>number</varname> )</b></codeblock> </refsyn>
+</refbody>
+</reference>

Propchange: db/derby/docs/trunk/src/ref/rreffuncsign.dita
------------------------------------------------------------------------------
    svn:eol-style = native

Added: db/derby/docs/trunk/src/ref/rreffuncsinh.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rreffuncsinh.dita?rev=611832&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rreffuncsinh.dita (added)
+++ db/derby/docs/trunk/src/ref/rreffuncsinh.dita Mon Jan 14 07:44:57 2008
@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="utf-8"?>
+ 
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
+<!-- 
+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.
+-->
+<reference id="rreffuncsinh" xml:lang="en-us">
+<title>SINH function</title>
+<shortdesc>The SINH function returns the hyperbolic sine of a specified number.</shortdesc>
+<prolog><metadata>
+<keywords><indexterm>SINH function</indexterm><indexterm>functions<indexterm>SINH</indexterm></indexterm>
+</keywords>
+</metadata></prolog>
+<refbody>
+<section> <p>The specified number is the angle, in radians, that you want the hyperbolic sine for. The specified number must be a <xref href="rrefsqljdoubleprecision.dita#rrefsqljdoubleprecision">DOUBLE PRECISION</xref> number.  
+<ul>
+<li>If the specified number is NULL, the result of this function is NULL.</li>
+<li>If the specified number is zero (0), the result of this function is zero.</li>
+</ul></p><p>The data type of the returned value is a DOUBLE PRECISION number.</p> </section>
+<refsyn><title>Syntax</title> <codeblock><b>SIN ( <varname>number</varname> )</b></codeblock> </refsyn>
+</refbody>
+</reference>

Propchange: db/derby/docs/trunk/src/ref/rreffuncsinh.dita
------------------------------------------------------------------------------
    svn:eol-style = native

Added: db/derby/docs/trunk/src/ref/rreffunctanh.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rreffunctanh.dita?rev=611832&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rreffunctanh.dita (added)
+++ db/derby/docs/trunk/src/ref/rreffunctanh.dita Mon Jan 14 07:44:57 2008
@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="utf-8"?>
+ 
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
+<!-- 
+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.
+-->
+<reference id="rreffunctanh" xml:lang="en-us">
+<title>TANH function</title>
+<shortdesc>The TANH function returns the hyperbolic tangent of a specified number.</shortdesc>
+<prolog><metadata>
+<keywords><indexterm>TANH function</indexterm><indexterm>functions<indexterm>TANH</indexterm></indexterm>
+</keywords>
+</metadata></prolog>
+<refbody>
+<section> <p>The specified number is the angle, in radians, that you want the hyperbolic tangent for. The specified number must be a <xref href="rrefsqljdoubleprecision.dita#rrefsqljdoubleprecision">DOUBLE PRECISION</xref> number.  
+<ul>
+<li>If the specified number is NULL, the result of this function is NULL.</li>
+<li>If the specified number is zero (0), the result of this function is zero.</li>
+</ul></p><p>The data type of the returned value is a DOUBLE PRECISION number.</p> </section>
+<refsyn><title>Syntax</title> <codeblock><b>TANH ( <varname>number</varname> )</b></codeblock> </refsyn>
+</refbody>
+</reference>

Propchange: db/derby/docs/trunk/src/ref/rreffunctanh.dita
------------------------------------------------------------------------------
    svn:eol-style = native