KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sf > jga > fn > arithmetic > FloatMath


1 // ============================================================================
2
// $Id: FloatMath.java,v 1.5 2005/08/02 23:45:06 davidahall Exp $
3
// Copyright (c) 2003-2005 David A. Hall
4
// ============================================================================
5
// The contents of this file are subject to the Common Development and
6
// Distribution License (CDDL), Version 1.0 (the License); you may not use this
7
// file except in compliance with the License. You should have received a copy
8
// of the the License along with this file: if not, a copy of the License is
9
// available from Sun Microsystems, Inc.
10
//
11
// http://www.sun.com/cddl/cddl.html
12
//
13
// From time to time, the license steward (initially Sun Microsystems, Inc.) may
14
// publish revised and/or new versions of the License. You may not use,
15
// distribute, or otherwise make this file available under subsequent versions
16
// of the License.
17
//
18
// Alternatively, the contents of this file may be used under the terms of the
19
// GNU Lesser General Public License Version 2.1 or later (the "LGPL"), in which
20
// case the provisions of the LGPL are applicable instead of those above. If you
21
// wish to allow use of your version of this file only under the terms of the
22
// LGPL, and not to allow others to use your version of this file under the
23
// terms of the CDDL, indicate your decision by deleting the provisions above
24
// and replace them with the notice and other provisions required by the LGPL.
25
// If you do not delete the provisions above, a recipient may use your version
26
// of this file under the terms of either the CDDL or the LGPL.
27
//
28
// This library is distributed in the hope that it will be useful,
29
// but WITHOUT ANY WARRANTY; without even the implied warranty of
30
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
31
// ============================================================================
32

33 /**
34  * Provides an implementation of Arithmetic for Floats
35  * <p>
36  * Copyright &copy; 2003-2005 David A. Hall
37  *
38  * @author <a HREF="mailto:dave@dolphin.hallsquared.org">David A. Hall</a>
39  */

40
41 package net.sf.jga.fn.arithmetic;
42
43 class FloatMath implements Arithmetic<Float JavaDoc> {
44
45     static final long serialVersionUID = 8813677408947677131L;
46          
47     static private final Float JavaDoc ZERO = new Float JavaDoc(0.0f);
48     static private final Float JavaDoc ONE = new Float JavaDoc(1.0f);
49     
50     /**
51      * Returns the given value in the appropriate type
52      * @throws IllegalArgumentException if the value cannot be converted
53      */

54
55     public Float JavaDoc valueOf(Number JavaDoc value) throws IllegalArgumentException JavaDoc {
56         return new Float JavaDoc(value.floatValue());
57     }
58
59     /**
60      * Returns the value 0 of the appropriate type
61      */

62
63     public Float JavaDoc zero() {
64         return ZERO;
65     }
66
67     /**
68      * Returns the value 1 of the appropriate type
69      */

70
71     public Float JavaDoc one() {
72         return ONE;
73     }
74
75    /**
76     * For numeric arguments x and y, returns x + y
77     * @return the sum of the two arguments
78     */

79
80     public Float JavaDoc plus (Float JavaDoc x, Float JavaDoc y) {
81         return new Float JavaDoc(x.floatValue() + y.floatValue());
82     }
83
84    /**
85     * For numeric arguments x and y, returns x - y
86     * @return the difference of the two arguments
87     */

88      
89     public Float JavaDoc minus (Float JavaDoc x, Float JavaDoc y) {
90         return new Float JavaDoc(x.floatValue() - y.floatValue());
91     }
92      
93    /**
94     * For numeric arguments x and y, returns x * y
95     * @return the product of the two arguments
96     */

97      
98
99     public Float JavaDoc multiplies (Float JavaDoc x, Float JavaDoc y){
100         return new Float JavaDoc(x.floatValue() * y.floatValue());
101     }
102          
103
104     /**
105      * For numeric arguments x and y, returns x / y
106      * @return the quotient of the two arguments
107      */

108
109     public Float JavaDoc divides (Float JavaDoc x, Float JavaDoc y) {
110         return new Float JavaDoc(x.floatValue() / y.floatValue());
111     }
112
113     /**
114      * for numeric argument x, returns -x
115      * @return the negative of its argument
116      */

117
118     public Float JavaDoc negate (Float JavaDoc x) {
119         return new Float JavaDoc(-x.floatValue());
120     }
121 }
122
Popular Tags