You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ah...@apache.org on 2019/12/09 00:03:40 UTC
[commons-numbers] 02/09: Document odd and even functions.
This is an automated email from the ASF dual-hosted git repository.
aherbert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-numbers.git
commit 2753fa05fecfa6fe0c738248ed24737dfb5056f4
Author: Alex Herbert <ah...@apache.org>
AuthorDate: Sun Dec 8 17:58:10 2019 +0000
Document odd and even functions.
---
.../java/org/apache/commons/numbers/complex/Complex.java | 16 ++++++++++------
1 file changed, 10 insertions(+), 6 deletions(-)
diff --git a/commons-numbers-complex/src/main/java/org/apache/commons/numbers/complex/Complex.java b/commons-numbers-complex/src/main/java/org/apache/commons/numbers/complex/Complex.java
index 19e00f4..2d88c2f 100644
--- a/commons-numbers-complex/src/main/java/org/apache/commons/numbers/complex/Complex.java
+++ b/commons-numbers-complex/src/main/java/org/apache/commons/numbers/complex/Complex.java
@@ -1102,6 +1102,8 @@ public final class Complex implements Serializable {
* </code>
* </pre>
*
+ * <p>This is an odd function: {@code f(z) = -f(-z)}.
+ *
* @return the inverse hyperbolic sine of this complex number
*/
public Complex asinh() {
@@ -1190,6 +1192,8 @@ public final class Complex implements Serializable {
* atanh(z) = (1/2) ln((1 + z) / (1 - z))
* </pre>
*
+ * <p>This is an odd function: {@code f(z) = -f(-z)}.
+ *
* @return the inverse hyperbolic tangent of this complex number
*/
public Complex atanh() {
@@ -1344,6 +1348,8 @@ public final class Complex implements Serializable {
* cosh(a + b i) = cosh(a)cos(b) + i sinh(a)sin(b)
* </pre>
*
+ * <p>This is an even function: {@code f(z) = f(-z)}.
+ *
* @return the hyperbolic cosine of this complex number.
*/
public Complex cosh() {
@@ -1594,9 +1600,8 @@ public final class Complex implements Serializable {
* <pre>
* sinh(a + b i) = sinh(a)cos(b)) + i cosh(a)sin(b)
* </pre>
- * where the (real) functions on the right-hand side are
- * {@link Math#sin}, {@link Math#cos},
- * {@link Math#cosh} and {@link Math#sinh}.
+ *
+ * <p>This is an odd function: {@code f(z) = -f(-z)}.
*
* @return the hyperbolic sine of {@code this}.
*/
@@ -1775,9 +1780,8 @@ public final class Complex implements Serializable {
* <pre>
* tan(a + b i) = sinh(2a)/(cosh(2a)+cos(2b)) + i [sin(2b)/(cosh(2a)+cos(2b))]
* </pre>
- * where the (real) functions on the right-hand side are
- * {@link Math#sin}, {@link Math#cos}, {@link Math#cosh} and
- * {@link Math#sinh}.
+ *
+ * <p>This is an odd function: {@code f(z) = -f(-z)}.
*
* @return the hyperbolic tangent of {@code this}.
*/