Java Doc for Complex.java in  » Science » jscience-4.3.1 » org » jscience » mathematics » number » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Science » jscience 4.3.1 » org.jscience.mathematics.number 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.jscience.mathematics.number.Complex

Complex
final public class Complex extends Number implements Field<Complex>(Code)

This class represents an immutable complex number.


author:
   Jean-Marie Dautelle
version:
   3.0, February 13, 2006
See Also:    * Wikipedia: Complex number


Field Summary
final public static  ComplexI
     The imaginary unit i.
final public static  ComplexONE
     The complex number one.
final static  XMLFormat<Complex>XML
     Holds the default XML representation for complex numbers. This representation consists of real and imaginary attributes (e.g.
final public static  ComplexZERO
     The complex number zero.


Method Summary
public  doubleargument()
     Returns the argument of this complex number.
public  intcompareTo(Complex that)
     Compares two complex numbers, the real components are compared first, then if equal, the imaginary components.
Parameters:
  that - the complex number to be compared with.
public  Complexconjugate()
     Returns the conjugate of this complex number.
public  Complexcopy()
    
public  Complexdivide(double k)
     Returns this complex divided by the specified factor.
Parameters:
  k - the factor divisor.
public  Complexdivide(Complex that)
     Returns this complex divided by the specified complex.
Parameters:
  that - the complex divisor.
public  doubledoubleValue()
     Returns the Complex.getReal real component of this Complex number as a double.
public  booleanequals(Complex that, double tolerance)
     Indicates if two complexes are "sufficiently" alike to be considered equal.
Parameters:
  that - the complex to compare with.
Parameters:
  tolerance - the maximum magnitude of the difference betweenthem before they are considered not equal.
public  booleanequals(Object that)
     Compares this complex against the specified Object.
Parameters:
  that - the object to compare with.
public  Complexexp()
     Returns the exponential number e raised to the power of this complex.
public  doublegetImaginary()
     Returns the imaginary component of this complex number.
public  doublegetReal()
     Returns the real component of this complex number.
public  inthashCode()
     Returns the hash code for this complex number.
public  Complexinverse()
     Returns the inverse of this complex.
public  booleanisInfinite()
     Indicates if either the real or imaginary component of this complex is infinite.
public  booleanisLargerThan(Complex that)
     Compares the Complex.magnitude() magnitude of this complex number with the magnitude of the complex number specified.
Parameters:
  that - the complex number to be compared with.
public  booleanisNaN()
     Indicates if either the real or imaginary component of this complex is not a number.
public  Complexlog()
     Returns the principal natural logarithm (base e) of this complex.
public  longlongValue()
     Returns the Complex.getReal real component of this Complex number as a long.
public  doublemagnitude()
     Returns the magnitude of this complex number, also referred to as the "modulus" or "length".
public  Complexminus(Complex that)
     Returns the difference between this complex and the one specified.
Parameters:
  that - the complex to be subtracted.
public  Complexopposite()
     Returns the negation of this complex.
public  Complexplus(Complex that)
     Returns the sum of this complex with the one specified.
Parameters:
  that - the complex to be added.
public  Complexpow(double e)
     Returns this complex raised to the specified power.
Parameters:
  e - the exponent.
public  Complexpow(Complex that)
     Returns this complex raised to the power of the specified complex exponent.
Parameters:
  that - the exponent.
public  Complexsqrt()
     Returns one of the two square root of this complex number.
public  Complextimes(double k)
     Returns this complex multiplied by the specified factor.
Parameters:
  k - the factor multiplier.
public  Complextimes(Complex that)
     Returns the product of this complex with the one specified.
Parameters:
  that - the complex multiplier.
public  TexttoText()
     Returns the text representation of this complex number.
public static  ComplexvalueOf(double real, double imaginary)
     Returns the complex number having the specified real and imaginary components.
Parameters:
  real - the real component of this complex number.
Parameters:
  imaginary - the imaginary component of this complex number.
public static  ComplexvalueOf(CharSequence csq)
     Returns the complex number for the specified character sequence.
Parameters:
  csq - the character sequence.

Field Detail
I
final public static Complex I(Code)
The imaginary unit i.



ONE
final public static Complex ONE(Code)
The complex number one.



XML
final static XMLFormat<Complex> XML(Code)
Holds the default XML representation for complex numbers. This representation consists of real and imaginary attributes (e.g. <Complex real="2.34" imaginary="-0.4"/>).



ZERO
final public static Complex ZERO(Code)
The complex number zero.





Method Detail
argument
public double argument()(Code)
Returns the argument of this complex number. It is the angle in radians, measured counter-clockwise from the real axis. argument of this complex number.



compareTo
public int compareTo(Complex that)(Code)
Compares two complex numbers, the real components are compared first, then if equal, the imaginary components.
Parameters:
  that - the complex number to be compared with. -1, 0, 1 based upon the ordering.



conjugate
public Complex conjugate()(Code)
Returns the conjugate of this complex number. (this.real(), - this.imaginary()).



copy
public Complex copy()(Code)



divide
public Complex divide(double k)(Code)
Returns this complex divided by the specified factor.
Parameters:
  k - the factor divisor. this / k.



divide
public Complex divide(Complex that)(Code)
Returns this complex divided by the specified complex.
Parameters:
  that - the complex divisor. this / that.



doubleValue
public double doubleValue()(Code)
Returns the Complex.getReal real component of this Complex number as a double. (double) this.getReal()



equals
public boolean equals(Complex that, double tolerance)(Code)
Indicates if two complexes are "sufficiently" alike to be considered equal.
Parameters:
  that - the complex to compare with.
Parameters:
  tolerance - the maximum magnitude of the difference betweenthem before they are considered not equal. true if they are considered equal;false otherwise.



equals
public boolean equals(Object that)(Code)
Compares this complex against the specified Object.
Parameters:
  that - the object to compare with. true if the objects are the same;false otherwise.



exp
public Complex exp()(Code)
Returns the exponential number e raised to the power of this complex. Note: ePI*i = -1 exp(this).



getImaginary
public double getImaginary()(Code)
Returns the imaginary component of this complex number. the imaginary component.



getReal
public double getReal()(Code)
Returns the real component of this complex number. the real component.



hashCode
public int hashCode()(Code)
Returns the hash code for this complex number. the hash code value.



inverse
public Complex inverse()(Code)
Returns the inverse of this complex. 1 / this.



isInfinite
public boolean isInfinite()(Code)
Indicates if either the real or imaginary component of this complex is infinite. true if this complex is infinite;false otherwise.



isLargerThan
public boolean isLargerThan(Complex that)(Code)
Compares the Complex.magnitude() magnitude of this complex number with the magnitude of the complex number specified.
Parameters:
  that - the complex number to be compared with. |this| > |that|



isNaN
public boolean isNaN()(Code)
Indicates if either the real or imaginary component of this complex is not a number. true if this complex is NaN;false otherwise.



log
public Complex log()(Code)
Returns the principal natural logarithm (base e) of this complex. Note: There are an infinity of solutions. log(this).



longValue
public long longValue()(Code)
Returns the Complex.getReal real component of this Complex number as a long. (long) this.getReal()



magnitude
public double magnitude()(Code)
Returns the magnitude of this complex number, also referred to as the "modulus" or "length". the magnitude of this complex number.



minus
public Complex minus(Complex that)(Code)
Returns the difference between this complex and the one specified.
Parameters:
  that - the complex to be subtracted. this - that.



opposite
public Complex opposite()(Code)
Returns the negation of this complex. -this.



plus
public Complex plus(Complex that)(Code)
Returns the sum of this complex with the one specified.
Parameters:
  that - the complex to be added. this + that.



pow
public Complex pow(double e)(Code)
Returns this complex raised to the specified power.
Parameters:
  e - the exponent. this**e.



pow
public Complex pow(Complex that)(Code)
Returns this complex raised to the power of the specified complex exponent.
Parameters:
  that - the exponent. this**that.



sqrt
public Complex sqrt()(Code)
Returns one of the two square root of this complex number. sqrt(this).



times
public Complex times(double k)(Code)
Returns this complex multiplied by the specified factor.
Parameters:
  k - the factor multiplier. this * k.



times
public Complex times(Complex that)(Code)
Returns the product of this complex with the one specified.
Parameters:
  that - the complex multiplier. this * that.



toText
public Text toText()(Code)
Returns the text representation of this complex number. TextFormat.getInstance(Complex.class).format(this)
See Also:   TextFormat.getInstance(Class)



valueOf
public static Complex valueOf(double real, double imaginary)(Code)
Returns the complex number having the specified real and imaginary components.
Parameters:
  real - the real component of this complex number.
Parameters:
  imaginary - the imaginary component of this complex number. the corresponding complex number.
See Also:   Complex.getReal
See Also:   Complex.getImaginary



valueOf
public static Complex valueOf(CharSequence csq)(Code)
Returns the complex number for the specified character sequence.
Parameters:
  csq - the character sequence. TextFormat.getInstance(Complex.class).parse(csq)
throws:
  IllegalArgumentException - if the character sequence does not contain a parsable complex number.
See Also:   TextFormat.getInstance(Class)



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.