Mercurial > hg > de.mpg.mpiwg.itgroup.digilib.core
view libs/commons-math-2.1/docs/apidocs/org/apache/commons/math/FieldElement.html @ 32:d7a43156a79b default tip
new tabs
author | dwinter |
---|---|
date | Mon, 10 Oct 2011 17:52:22 +0200 |
parents | 878723cc40fb |
children |
line wrap: on
line source
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!--NewPage--> <HTML> <HEAD> <!-- Generated by javadoc (build 1.6.0_17) on Sat Mar 27 22:46:09 EDT 2010 --> <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> <TITLE> FieldElement (Commons Math 2.1 API) </TITLE> <META NAME="date" CONTENT="2010-03-27"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> <SCRIPT type="text/javascript"> function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="FieldElement (Commons Math 2.1 API)"; } } </SCRIPT> <NOSCRIPT> </NOSCRIPT> </HEAD> <BODY BGCOLOR="white" onload="windowTitle();"> <HR> <!-- ========= START OF TOP NAVBAR ======= --> <A NAME="navbar_top"><!-- --></A> <A HREF="#skip-navbar_top" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_top_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/FieldElement.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../org/apache/commons/math/Field.html" title="interface in org.apache.commons.math"><B>PREV CLASS</B></A> <A HREF="../../../../org/apache/commons/math/FunctionEvaluationException.html" title="class in org.apache.commons.math"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?org/apache/commons/math/FieldElement.html" target="_top"><B>FRAMES</B></A> <A HREF="FieldElement.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_top"></A> <!-- ========= END OF TOP NAVBAR ========= --> <HR> <!-- ======== START OF CLASS DATA ======== --> <H2> <FONT SIZE="-1"> org.apache.commons.math</FONT> <BR> Interface FieldElement<T></H2> <DL> <DT><DT><B>Type Parameters:</B><DD><CODE>T</CODE> - the type of the field elements</DL> <DL> <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/commons/math/fraction/BigFraction.html" title="class in org.apache.commons.math.fraction">BigFraction</A>, <A HREF="../../../../org/apache/commons/math/util/BigReal.html" title="class in org.apache.commons.math.util">BigReal</A>, <A HREF="../../../../org/apache/commons/math/complex/Complex.html" title="class in org.apache.commons.math.complex">Complex</A>, <A HREF="../../../../org/apache/commons/math/fraction/Fraction.html" title="class in org.apache.commons.math.fraction">Fraction</A></DD> </DL> <HR> <DL> <DT><PRE>public interface <A HREF="../../../../src-html/org/apache/commons/math/FieldElement.html#line.27"><B>FieldElement<T></B></A></DL> </PRE> <P> Interface representing <a href="http://mathworld.wolfram.com/Field.html">field</a> elements. <P> <P> <DL> <DT><B>Since:</B></DT> <DD>2.0</DD> <DT><B>Version:</B></DT> <DD>$Revision: 811685 $ $Date: 2009-09-05 13:36:48 -0400 (Sat, 05 Sep 2009) $</DD> <DT><B>See Also:</B><DD><A HREF="../../../../org/apache/commons/math/Field.html" title="interface in org.apache.commons.math"><CODE>Field</CODE></A></DL> <HR> <P> <!-- ========== METHOD SUMMARY =========== --> <A NAME="method_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Method Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../org/apache/commons/math/FieldElement.html" title="type parameter in FieldElement">T</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/math/FieldElement.html#add(T)">add</A></B>(<A HREF="../../../../org/apache/commons/math/FieldElement.html" title="type parameter in FieldElement">T</A> a)</CODE> <BR> Compute this + a.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../org/apache/commons/math/FieldElement.html" title="type parameter in FieldElement">T</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/math/FieldElement.html#divide(T)">divide</A></B>(<A HREF="../../../../org/apache/commons/math/FieldElement.html" title="type parameter in FieldElement">T</A> a)</CODE> <BR> Compute this ÷ a.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../org/apache/commons/math/Field.html" title="interface in org.apache.commons.math">Field</A><<A HREF="../../../../org/apache/commons/math/FieldElement.html" title="type parameter in FieldElement">T</A>></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/math/FieldElement.html#getField()">getField</A></B>()</CODE> <BR> Get the <A HREF="../../../../org/apache/commons/math/Field.html" title="interface in org.apache.commons.math"><CODE>Field</CODE></A> to which the instance belongs.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../org/apache/commons/math/FieldElement.html" title="type parameter in FieldElement">T</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/math/FieldElement.html#multiply(T)">multiply</A></B>(<A HREF="../../../../org/apache/commons/math/FieldElement.html" title="type parameter in FieldElement">T</A> a)</CODE> <BR> Compute this × a.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../org/apache/commons/math/FieldElement.html" title="type parameter in FieldElement">T</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../org/apache/commons/math/FieldElement.html#subtract(T)">subtract</A></B>(<A HREF="../../../../org/apache/commons/math/FieldElement.html" title="type parameter in FieldElement">T</A> a)</CODE> <BR> Compute this - a.</TD> </TR> </TABLE> <P> <!-- ============ METHOD DETAIL ========== --> <A NAME="method_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Method Detail</B></FONT></TH> </TR> </TABLE> <A NAME="add(java.lang.Object)"><!-- --></A><A NAME="add(T)"><!-- --></A><H3> add</H3> <PRE> <A HREF="../../../../org/apache/commons/math/FieldElement.html" title="type parameter in FieldElement">T</A> <A HREF="../../../../src-html/org/apache/commons/math/FieldElement.html#line.33"><B>add</B></A>(<A HREF="../../../../org/apache/commons/math/FieldElement.html" title="type parameter in FieldElement">T</A> a)</PRE> <DL> <DD>Compute this + a. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>a</CODE> - element to add <DT><B>Returns:</B><DD>a new element representing this + a</DL> </DD> </DL> <HR> <A NAME="subtract(java.lang.Object)"><!-- --></A><A NAME="subtract(T)"><!-- --></A><H3> subtract</H3> <PRE> <A HREF="../../../../org/apache/commons/math/FieldElement.html" title="type parameter in FieldElement">T</A> <A HREF="../../../../src-html/org/apache/commons/math/FieldElement.html#line.39"><B>subtract</B></A>(<A HREF="../../../../org/apache/commons/math/FieldElement.html" title="type parameter in FieldElement">T</A> a)</PRE> <DL> <DD>Compute this - a. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>a</CODE> - element to subtract <DT><B>Returns:</B><DD>a new element representing this - a</DL> </DD> </DL> <HR> <A NAME="multiply(java.lang.Object)"><!-- --></A><A NAME="multiply(T)"><!-- --></A><H3> multiply</H3> <PRE> <A HREF="../../../../org/apache/commons/math/FieldElement.html" title="type parameter in FieldElement">T</A> <A HREF="../../../../src-html/org/apache/commons/math/FieldElement.html#line.45"><B>multiply</B></A>(<A HREF="../../../../org/apache/commons/math/FieldElement.html" title="type parameter in FieldElement">T</A> a)</PRE> <DL> <DD>Compute this × a. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>a</CODE> - element to multiply <DT><B>Returns:</B><DD>a new element representing this × a</DL> </DD> </DL> <HR> <A NAME="divide(java.lang.Object)"><!-- --></A><A NAME="divide(T)"><!-- --></A><H3> divide</H3> <PRE> <A HREF="../../../../org/apache/commons/math/FieldElement.html" title="type parameter in FieldElement">T</A> <A HREF="../../../../src-html/org/apache/commons/math/FieldElement.html#line.53"><B>divide</B></A>(<A HREF="../../../../org/apache/commons/math/FieldElement.html" title="type parameter in FieldElement">T</A> a) throws <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/ArithmeticException.html?is-external=true" title="class or interface in java.lang">ArithmeticException</A></PRE> <DL> <DD>Compute this ÷ a. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>a</CODE> - element to add <DT><B>Returns:</B><DD>a new element representing this ÷ a <DT><B>Throws:</B> <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/ArithmeticException.html?is-external=true" title="class or interface in java.lang">ArithmeticException</A></CODE> - if a is the zero of the additive operation (i.e. additive identity)</DL> </DD> </DL> <HR> <A NAME="getField()"><!-- --></A><H3> getField</H3> <PRE> <A HREF="../../../../org/apache/commons/math/Field.html" title="interface in org.apache.commons.math">Field</A><<A HREF="../../../../org/apache/commons/math/FieldElement.html" title="type parameter in FieldElement">T</A>> <A HREF="../../../../src-html/org/apache/commons/math/FieldElement.html#line.58"><B>getField</B></A>()</PRE> <DL> <DD>Get the <A HREF="../../../../org/apache/commons/math/Field.html" title="interface in org.apache.commons.math"><CODE>Field</CODE></A> to which the instance belongs. <P> <DD><DL> <DT><B>Returns:</B><DD><A HREF="../../../../org/apache/commons/math/Field.html" title="interface in org.apache.commons.math"><CODE>Field</CODE></A> to which the instance belongs</DL> </DD> </DL> <!-- ========= END OF CLASS DATA ========= --> <HR> <!-- ======= START OF BOTTOM NAVBAR ====== --> <A NAME="navbar_bottom"><!-- --></A> <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/FieldElement.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../org/apache/commons/math/Field.html" title="interface in org.apache.commons.math"><B>PREV CLASS</B></A> <A HREF="../../../../org/apache/commons/math/FunctionEvaluationException.html" title="class in org.apache.commons.math"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?org/apache/commons/math/FieldElement.html" target="_top"><B>FRAMES</B></A> <A HREF="FieldElement.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> <HR> Copyright © 2003-2010 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. </BODY> </HTML>