edu.jas.poly.ComplexRing Maven / Gradle / Ivy
The newest version!
/*
* $Id: ComplexRing.java 3882 2012-02-05 17:53:12Z kredel $
*/
package edu.jas.poly;
import java.io.Reader;
import java.math.BigInteger;
import java.util.ArrayList;
import java.util.List;
import java.util.Random;
import org.apache.log4j.Logger;
import edu.jas.kern.StringUtil;
import edu.jas.structure.GcdRingElem;
import edu.jas.structure.RingElem;
import edu.jas.structure.RingFactory;
/**
* Generic Complex ring factory implementing the RingFactory interface. Objects
* of this class are immutable.
* @param base type.
* @author Heinz Kredel
*/
public class ComplexRing> implements RingFactory> {
private final static Random random = new Random();
@SuppressWarnings("unused")
private static final Logger logger = Logger.getLogger(ComplexRing.class);
/**
* Complex class elements factory data structure.
*/
public final RingFactory ring;
/**
* The constructor creates a ComplexRing object.
* @param ring factory for Complex real and imaginary parts.
*/
public ComplexRing(RingFactory ring) {
this.ring = ring;
}
/**
* Get a list of the generating elements.
* @return list of generators for the algebraic structure.
* @see edu.jas.structure.ElemFactory#generators()
*/
public List> generators() {
List gens = ring.generators();
List> g = new ArrayList>(gens.size() + 1);
for (C x : gens) {
Complex cx = new Complex(this, x);
g.add(cx);
}
g.add(getIMAG());
return g;
}
/**
* Corresponding algebraic number ring.
* @return algebraic number ring.
* not jet possible.
*/
public AlgebraicNumberRing algebraicRing() {
GenPolynomialRing pfac
= new GenPolynomialRing(ring, 1, new TermOrder(TermOrder.INVLEX), new String[] { "I" });
GenPolynomial I = pfac.univariate(0, 2L).sum(pfac.getONE());
AlgebraicNumberRing afac = new AlgebraicNumberRing(I, ring.isField()); // must indicate field
return afac;
}
/**
* Is this structure finite or infinite.
* @return true if this structure is finite, else false.
* @see edu.jas.structure.ElemFactory#isFinite()
*/
public boolean isFinite() {
return ring.isFinite();
}
/**
* Copy Complex element c.
* @param c Complex<C>.
* @return a copy of c.
*/
public Complex copy(Complex c) {
return new Complex(this, c.re, c.im);
}
/**
* Get the zero element.
* @return 0 as Complex<C>.
*/
public Complex getZERO() {
return new Complex(this);
}
/**
* Get the one element.
* @return 1 as Complex<C>.
*/
public Complex getONE() {
return new Complex(this, ring.getONE());
}
/**
* Get the i element.
* @return i as Complex<C>.
*/
public Complex getIMAG() {
return new Complex(this, ring.getZERO(), ring.getONE());
}
/**
* Query if this ring is commutative.
* @return true.
*/
public boolean isCommutative() {
return ring.isCommutative();
}
/**
* Query if this ring is associative.
* @return true.
*/
public boolean isAssociative() {
return ring.isAssociative();
}
/**
* Query if this ring is a field.
* @return true.
*/
public boolean isField() {
return ring.isField();
}
/**
* Characteristic of this ring.
* @return characteristic of this ring.
*/
public java.math.BigInteger characteristic() {
return ring.characteristic();
}
/**
* Get a Complex element from a BigInteger.
* @param a BigInteger.
* @return a Complex<C>.
*/
public Complex fromInteger(BigInteger a) {
return new Complex(this, ring.fromInteger(a));
}
/**
* Get a Complex element from a long.
* @param a long.
* @return a Complex<C>.
*/
public Complex fromInteger(long a) {
return new Complex(this, ring.fromInteger(a));
}
/**
* Get the String representation.
*/
@Override
public String toString() {
StringBuffer sb = new StringBuffer();
sb.append("Complex[");
if (ring instanceof RingElem) {
RingElem ri = (RingElem) ring;
sb.append(ri.toScriptFactory());
} else {
sb.append(ring.toString());
}
sb.append("]");
return sb.toString();
}
/**
* Get a scripting compatible string representation.
* @return script compatible representation for this Element.
* @see edu.jas.structure.Element#toScript()
*/
//JAVA6only: @Override
public String toScript() {
// Python case
StringBuffer s = new StringBuffer();
s.append("CR(");
if (ring instanceof RingElem) {
RingElem ri = (RingElem) ring;
s.append(ri.toScriptFactory());
} else {
s.append(ring.toScript());
}
s.append(")");
return s.toString();
}
/**
* Comparison with any other object.
* @see java.lang.Object#equals(java.lang.Object)
*/
@Override
@SuppressWarnings("unchecked")
public boolean equals(Object b) {
if (!(b instanceof ComplexRing)) {
return false;
}
ComplexRing a = null;
try {
a = (ComplexRing) b;
} catch (ClassCastException e) {
}
if (a == null) {
return false;
}
if (!ring.equals(a.ring)) {
return false;
}
return true;
}
/**
* Hash code for this ComplexRing<C>.
* @see java.lang.Object#hashCode()
*/
@Override
public int hashCode() {
return ring.hashCode();
}
/**
* Complex number random. Random base numbers A and B are generated using
* random(n). Then R is the complex number with real part A and imaginary
* part B.
* @param n such that 0 ≤ A, B ≤ (2n-1).
* @return R.
*/
public Complex random(int n) {
return random(n, random);
// C r = ring.random( n ).abs();
// C i = ring.random( n ).abs();
// return new Complex(this, r, i );
}
/**
* Complex number random. Random base numbers A and B are generated using
* random(n). Then R is the complex number with real part A and imaginary
* part B.
* @param n such that 0 ≤ A, B ≤ (2n-1).
* @param rnd is a source for random bits.
* @return R.
*/
public Complex random(int n, Random rnd) {
C r = ring.random(n, rnd);
C i = ring.random(n, rnd);
return new Complex(this, r, i);
}
/**
* Parse complex number from string.
* @param s String.
* @return Complex from s.
*/
public Complex parse(String s) {
return new Complex(this, s);
}
/**
* Parse complex number from Reader.
* @param r Reader.
* @return next Complex from r.
*/
public Complex parse(Reader r) {
return parse(StringUtil.nextString(r));
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy