DecimalMath


1   // ============================================================================
2   // $Id: DecimalMath.java,v 1.5 2005/08/02 23:45:05 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  package net.sf.jga.fn.arithmetic;
34  
35  import java.math.BigDecimal  ;
36  
37  /**
38   * Provides Arithmetic implementation for BigDecimals
39   * <p>
40   * Copyright &copy; 2003-2005  David A. Hall
41   *
42   * @author <a HREF="mailto:davidahall@users.sourceforge.net">David A. Hall</a>
43   */
44  
45  class DecimalMath implements Arithmetic<BigDecimal  > {
46  
47      static final long serialVersionUID = 2565703485705053014L;    
48  
49      static private final BigDecimal   ZERO = new BigDecimal  (0.0);
50      static private final BigDecimal   ONE  = new BigDecimal  (1.0);
51      
52      /**
53       * Returns the given value in the appropriate type
54       * @throws IllegalArgumentException if the value cannot be converted
55       */
56  
57      public BigDecimal   valueOf(Number   value) throws IllegalArgumentException   {
58          if (value instanceof BigDecimal  )
59              return (BigDecimal  ) value;
60          else
61              return new BigDecimal  (value.toString());
62      }
63  
64      /**
65       * Returns the value 0 of the appropriate type
66       */
67  
68      public BigDecimal   zero() {
69          return ZERO;
70      }
71  
72      /**
73       * Returns the value 1 of the appropriate type
74       */
75  
76      public BigDecimal   one() {
77          return ONE;
78      }
79  
80     /**
81      * For numeric arguments x and y, returns x + y
82      * @return the sum of the two arguments
83      */
84  
85      public BigDecimal   plus (BigDecimal   x, BigDecimal   y) {
86          return x.add(y);
87      }
88  
89     /**
90      * For numeric arguments x and y, returns x - y
91      * @return the difference of the two arguments
92      */
93       
94      public BigDecimal   minus (BigDecimal   x, BigDecimal   y) {
95          return x.subtract(y);
96      }
97       
98     /**
99      * For numeric arguments x and y, returns x * y
100     * @return the product of the two arguments
101     */
102      
103 
104     public BigDecimal   multiplies (BigDecimal   x, BigDecimal   y){
105         return x.multiply(y);
106     }
107          
108 
109     /**
110      * For numeric arguments x and y, returns x / y (rounded HALF_UP)
111      * @return the quotient of the two arguments
112      */
113 
114     public BigDecimal   divides (BigDecimal   x, BigDecimal   y) {
115         return x.divide(y,BigDecimal.ROUND_HALF_UP);
116     }
117 
118     /**
119      * for numeric argument x, returns -x
120      * @return the negative of its argument
121      */
122 
123     public BigDecimal   negate (BigDecimal   x) {
124         return x.negate();
125     }
126 }
127
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags