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 ch...@apache.org on 2008/10/01 22:13:32 UTC
svn commit: r700901 - in /db/derby/docs/trunk/src/ref: refderby.ditamap
rreffuncatan2.dita rrefjdbc88908.dita rrefsqlj55788.dita
Author: chaase3
Date: Wed Oct 1 13:13:32 2008
New Revision: 700901
URL: http://svn.apache.org/viewvc?rev=700901&view=rev
Log:
DERBY-3874: Document numeric function ATAN2(float1,float2)
Added a topic, rreffuncatan2.dita, and modified rrefjdbc88908.dita (JDBC escape syntax for fn keyword) and rrefsqlj55788.dita (Standard built-in functions) to include this new function.
Patch: DERBY-3874.diff
Added:
db/derby/docs/trunk/src/ref/rreffuncatan2.dita (with props)
Modified:
db/derby/docs/trunk/src/ref/refderby.ditamap
db/derby/docs/trunk/src/ref/rrefjdbc88908.dita
db/derby/docs/trunk/src/ref/rrefsqlj55788.dita
Modified: db/derby/docs/trunk/src/ref/refderby.ditamap
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/refderby.ditamap?rev=700901&r1=700900&r2=700901&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/refderby.ditamap (original)
+++ db/derby/docs/trunk/src/ref/refderby.ditamap Wed Oct 1 13:13:32 2008
@@ -219,6 +219,7 @@
<topicref href="rreffuncacos.dita" navtitle="ACOS function"></topicref>
<topicref href="rreffuncasin.dita" navtitle="ASIN function"></topicref>
<topicref href="rreffuncatan.dita" navtitle="ATAN function"></topicref>
+<topicref href="rreffuncatan2.dita" navtitle="ATAN2 function"></topicref>
<topicref href="rrefsqlj32693.dita" navtitle="AVG function"></topicref>
<topicref href="rrefbuiltbigint.dita" navtitle="BIGINT function"></topicref>
<topicref href="rrefcase.dita" navtitle="CASE expressions"></topicref>
Added: db/derby/docs/trunk/src/ref/rreffuncatan2.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rreffuncatan2.dita?rev=700901&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rreffuncatan2.dita (added)
+++ db/derby/docs/trunk/src/ref/rreffuncatan2.dita Wed Oct 1 13:13:32 2008
@@ -0,0 +1,55 @@
+<?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="rreffuncatan2" xml:lang="en-us">
+<title>ATAN2 function</title>
+<shortdesc>The ATAN2 function returns the arctangent, in radians, of the
+quotient of the two arguments.</shortdesc>
+<prolog><metadata>
+<keywords><indexterm>ATAN2 function</indexterm>
+<indexterm>functions<indexterm>ATAN2</indexterm></indexterm>
+</keywords>
+</metadata></prolog>
+<refbody>
+<section>
+<p>Upon successful completion, the function returns the arc tangent of
+<i>y</i>/<i>x</i> in the range -<i>pi</i> to <i>pi</i> radians, where <i>y</i>
+is the first argument and <i>x</i> is the second argument. The specified numbers
+must be <xref href="rrefsqljdoubleprecision.dita#rrefsqljdoubleprecision">DOUBLE
+PRECISION</xref> numbers.</p>
+<ul>
+<li>If either argument is NULL, the result of the function is NULL.</li>
+<li>If the first argument is zero and the second argument is positive, the
+result of the function is zero.</li>
+<li>If the first argument is zero and the second argument is negative, the
+result of the function is the double value closest to <i>pi</i>.</li>
+<li>If the first argument is positive and the second argument is zero, the
+result is the double value closest to <i>pi</i>/2.</li>
+<li>If the first argument is negative and the second argument is zero, the
+result is the double value closest to -<i>pi</i>/2.</li>
+</ul>
+<p>The data type of the returned value is a DOUBLE PRECISION number.</p>
+</section>
+<refsyn><title>Syntax</title>
+<codeblock><b>ATAN2 ( <varname>y</varname>, <varname>x</varname> )</b>
+</codeblock>
+</refsyn>
+</refbody>
+</reference>
Propchange: db/derby/docs/trunk/src/ref/rreffuncatan2.dita
------------------------------------------------------------------------------
svn:eol-style = native
Modified: db/derby/docs/trunk/src/ref/rrefjdbc88908.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbc88908.dita?rev=700901&r1=700900&r2=700901&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbc88908.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbc88908.dita Wed Oct 1 13:13:32 2008
@@ -32,7 +32,8 @@
scalar function</indexterm></indexterm><indexterm>TIMESTAMPDIFF function<indexterm>JDBC
scalar function</indexterm></indexterm><indexterm>acos<indexterm>JDBC scalar
function</indexterm></indexterm><indexterm>asin<indexterm>JDBC scalar function</indexterm></indexterm>
-<indexterm>atan<indexterm>JDBC scalar function</indexterm></indexterm><indexterm>ceiling<indexterm>JDBC
+<indexterm>atan<indexterm>JDBC scalar function</indexterm></indexterm>
+<indexterm>atan2<indexterm>JDBC scalar function</indexterm></indexterm><indexterm>ceiling<indexterm>JDBC
scalar function</indexterm></indexterm><indexterm>cos<indexterm>JDBC scalar
function</indexterm></indexterm><indexterm>degrees<indexterm>JDBC scalar function</indexterm></indexterm>
<indexterm>exp<indexterm>JDBC scalar function</indexterm></indexterm><indexterm>floor<indexterm>JDBC
@@ -67,6 +68,13 @@
JDBC escape syntax {fn atan(<i>number</i>)} is equivalent to the built-in
syntax ATAN(number). For more information, see <xref href="rreffuncatan.dita#rreffuncatan"></xref>.</p></dd>
</dlentry><dlentry>
+<dt>atan2</dt>
+<dd>Returns the arc tangent in radians of <i>y</i>/<i>x</i>.
+<codeblock><b>atan2(<i>y</i>, <i>x</i>)</b></codeblock><p>The
+JDBC escape syntax {fn atan2(<i>y</i>, <i>x</i>)} is equivalent to the built-in
+syntax ATAN2(<i>y</i>, <i>x</i>). For more information, see
+<xref href="rreffuncatan2.dita#rreffuncatan2"></xref>.</p></dd>
+</dlentry><dlentry>
<dt>ceiling</dt>
<dd>Rounds the specified number up, and returns the smallest number that is
greater than or equal to the specified number.<codeblock><b>ceiling(<i>number</i>)</b></codeblock><p>The
Modified: db/derby/docs/trunk/src/ref/rrefsqlj55788.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsqlj55788.dita?rev=700901&r1=700900&r2=700901&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsqlj55788.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefsqlj55788.dita Wed Oct 1 13:13:32 2008
@@ -30,6 +30,7 @@
<li><xref href="rreffuncacos.dita#rreffuncacos"></xref></li>
<li><xref href="rreffuncasin.dita#rreffuncasin"></xref></li>
<li><xref href="rreffuncatan.dita#rreffuncatan"></xref></li>
+<li><xref href="rreffuncatan2.dita#rreffuncatan2"></xref></li>
<li><xref href="rrefbuiltbigint.dita#rrefbuiltbigint"></xref></li>
<li><xref href="rrefsqlj33562.dita#rrefsqlj33562"></xref></li>
<li><xref href="rreffuncceil.dita#rreffuncceil"></xref></li>