SparseMatrixCS.java

Go to the documentation of this file.

package aud.graph.matrix;
 
import java.util.Map;
import java.util.TreeMap;
import java.util.SortedMap;
import java.io.*;
 
import aud.Vector;
import aud.util.Colormap;
import aud.util.SVGViewer;
 
public class SparseMatrixCS<T>  {
 
  protected TreeMap<Coordinate,T> mat_;
 
  public SparseMatrixCS() {
    mat_=new TreeMap<Coordinate,T>();
  }
  public SparseMatrixCS(SparseMatrixCS<T> other) {
    mat_=new TreeMap<Coordinate,T>(other.mat_);
  }
 
  public int nnz() { return mat_.size(); }
 
  public int getNumRows() {
    int imax=0;
    for (Coordinate c : mat_.keySet()) {
      if (c.i>imax)
        imax=c.i;
    }
    return imax;
  }
  public int getMinRowIndex() {
    int imin=Integer.MAX_VALUE;
    for (Coordinate c : mat_.keySet()) {
      if (c.i<imin)
        imin=c.i;
    }
    return (imin==Integer.MAX_VALUE) ? 0 : imin;
  }
  public int getNumColumns() { return mat_.size()==0 ? 0 : mat_.lastKey().j; }
  public int getMinColumnIndex() { return mat_.size()==0 ? 0 : mat_.firstKey().j; }
 
  TreeMap<Coordinate,T> check(int i,int j) {
    if (!(0<=i && 0<=j))
      throw new IndexOutOfBoundsException();
    return mat_;
  }
 
  public T get(int i,int j) {
    return check(i,j).get(new Coordinate(i,j));
  }
 
  public T set(int i,int j,T data) { return _set(i,j,data); }
 
  T _set(int i,int j,T data) {
    T e=get(i,j);
 
    if (e!=data) {
      Coordinate key=new Coordinate(i,j);
 
      if (data==null)
        mat_.remove(key);
      else
        mat_.put(key,data);
    }
    return e;
  }
 
  @SuppressWarnings("unchecked")
  public Vector<T> getColumnEntries(int j) {
    SortedMap<Coordinate,T> sub=
      check(1,j).subMap(new Coordinate(-1,j),
                        new Coordinate(Integer.MAX_VALUE,j));
    Object[] a=sub.values().toArray();
    Vector<T> v=new Vector<T>();
    v.reserve(a.length);
    for (int i=0;i<a.length;++i)
      v.push_back((T) a[i]);
    return v;
  }
 
  public int[] getColumnRowIndices(int j) {
    SortedMap<Coordinate,T> sub=
      check(1,j).subMap(new Coordinate(-1,j),
                        new Coordinate(Integer.MAX_VALUE,j));
    int[] idx=new int[sub.size()];
    int i=0;
    for (Coordinate c : sub.keySet()) {
      idx[i++]=c.i;
    }
    assert(i==idx.length);
    return idx;
  }
 
  public int columnDegree(int j) { return getColumnEntries(j).size(); }
 
 
  public SparseMatrixCS<T> getTransposed() {
    SparseMatrixCS<T> m=new SparseMatrixCS<T>();
    for (Map.Entry<Coordinate,T> entry : mat_.entrySet()) {
      Coordinate c=entry.getKey();
      m.mat_.put(new Coordinate(c.j,c.i),entry.getValue());
    }
    return m;
  }
 
  public SparseMatrixCS<Integer> spones() {
    SparseMatrixCS<Integer> m=new SparseMatrixCS<Integer>();
    for (Map.Entry<Coordinate,T> entry : mat_.entrySet())
      m.mat_.put(entry.getKey(),1);
    return m;
  }
 
  //
  // helpers
  //
 
  public int[] getRowIndices() {
    int[] ri=new int[nnz()];
    int i=0;
    for (Map.Entry<Coordinate,T> entry : mat_.entrySet())
      ri[i++]=entry.getKey().i;
    return ri;
  }
  public int[] getColumnIndices() {
    int[] ci=new int[nnz()];
    int i=0;
    for (Map.Entry<Coordinate,T> entry : mat_.entrySet())
      ci[i++]=entry.getKey().j;
    return ci;
  }
  @SuppressWarnings("unchecked")
  public T[] getValues() {
    T[] values=(T[]) new Object[nnz()];
    int i=0;
    for (Map.Entry<Coordinate,T> entry : mat_.entrySet())
      values[i++]=entry.getValue();
    return values;
  }
 
  @Override public String toString() {
    String rv="[";
    for (Map.Entry<Coordinate,T> entry : mat_.entrySet()) {
      rv+=entry+" ";
    }
    return rv.trim()+"]";
  }
 
  //
  // visualize matrix in various ways
  //
 
  public String toLaTeX(String name) {
    String rv="\\matrix ("+name+") [matrix of math nodes]\n{\n";
    int m=getNumRows(),n=getNumColumns();
    Class<?> intclass=Integer.valueOf(1).getClass();
    for (int i=getMinRowIndex();i<=m;++i) {
      for (int j=getMinColumnIndex();j<=n;++j) {
        T v=get(i,j);
        if (v!=null) {
          rv+=" ";
          rv+=(v.getClass()==intclass) ? v.toString() : "1";
        }
        if (j!=n)
          rv+=" &";
      }
      rv+=" \\\\\n";
    }
    rv+="};\n";
    return rv;
  }
 
  public File renderSpySVG(File svgfile,Colormap<T> colormap) {
    if (colormap==null)
      colormap=new Colormap<T>();
 
    try {
      FileOutputStream f=new FileOutputStream(svgfile);
 
      // write header
      float sz=5.0f; // cell size
      float r=2.0f;  // radius
      float w=(getNumColumns()+1)*sz, h=(getNumRows()+1)*sz;
 
      String buf=
        "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"+
        "<svg xmlns=\"http://www.w3.org/2000/svg\"\n"+
        " width=\""+w+"mm\"\n"+
        " height=\""+h+"mm\"\n"+
        " version=\"1.1\"\n>\n\n";
      f.write(buf.getBytes());
 
      // rulers
      f.write(("<line x1=\""+0+"mm\" y1=\""+(sz-r)+
               "mm\" x2=\""+w+"mm\" y2=\""+(sz-r)+"mm\" "+
               "style=\"stroke:#000000;stroke-width:1pt\"/>\n").getBytes());
      for (int i=1;i<=getNumColumns();++i) {
        float x=sz*(0.5f+i);
        f.write(("<line x1=\""+x+"mm\" y1=\""+(r)+
                 "mm\" x2=\""+x+"mm\" y2=\""+(r+r)+"mm\" "+
                 "style=\"stroke:#000000;stroke-width:1pt\"/>\n").getBytes());
      }
      f.write(("<line x1=\""+(sz-r)+"mm\" y1=\""+0+
               "mm\" x2=\""+(sz-r)+"mm\" y2=\""+h+"mm\" "+
               "style=\"stroke:#000000;stroke-width:1pt\"/>\n").getBytes());
      for (int i=1;i<=getNumRows();++i) {
        float y=sz*(0.5f+i);
        f.write(("<line x1=\""+(r)+"mm\" y1=\""+y+
                 "mm\" x2=\""+(r+r)+"mm\" y2=\""+(y)+"mm\" "+
                 "style=\"stroke:#000000;stroke-width:1pt\"/>\n").getBytes());
      }
      f.write("\n\n".getBytes());
 
      // data
      for (Map.Entry<Coordinate,T> entry : mat_.entrySet()) {
        float x=sz*(0.5f+entry.getKey().j), y=sz*(0.5f+entry.getKey().i);
        String fill=String.format("%06x",colormap.getRGB(entry.getValue()));
 
        buf="<circle style=\"fill:#"+fill+";stroke:#000000;stroke-width:0px\" "+
            "r=\""+r+"mm\" cx=\""+x+"mm\" cy=\""+y+"mm\"/>\n";
        f.write(buf.getBytes());
      }
 
      f.write("</svg>\n".getBytes());
      f.close();
    } catch (IOException e) {
      System.err.println("ERROR: "+e.getMessage());
      return null; // note: probably triggers NullPointerException
    }
    return svgfile;
  }
 
  public String spyTikZ(boolean rulers,Colormap<T> colormap) {
    if (colormap==null)
      colormap=new Colormap<T>();
 
    String s="\\begin{tikzpicture}[dot/.style={draw=none,fill=c},scale=1]\n";
 
    if (rulers) {
      s+="  \\foreach \\y in {0,...,"+(getNumRows()-1)+"} {\n"+
         "     \\draw (-2.5pt,-\\y) -- (2.5pt,-\\y);\n"+
         "     \\node[left] at (-1ex,-\\y-0.5) {{\\scriptsize \\y}};\n"+
         "  }\n"+
         "  \\draw (0,0) -- (0,-"+getNumRows()+");\n\n"
         ;
      s+="  \\foreach \\x in {1,...,"+(getNumColumns())+"} {\n"+
      "     \\draw (\\x,-2.5pt) -- (\\x,2.5pt);\n"+
      "     \\node[above] at (\\x-0.5,0) {{\\scriptsize \\x}};\n"+
      "  }\n"+
      "  \\draw (0,0) -- ("+(getNumColumns())+",0);\n\n"
      ;
    }
 
    float sz=1;
    for (Map.Entry<Coordinate,T> entry : mat_.entrySet()) {
      int rgb=colormap.getRGB(entry.getValue());
      float r=(float) (rgb>>16)/255.0f;
      float g=(float) ((rgb>> 8)&0xff)/255.0f;
      float b=(float) (rgb&0xff)/255.0f;
      s+="  \\definecolor{c}{rgb}{"+r+","+g+","+b+"}\n";
      float x=sz*(-0.5f+entry.getKey().j), y=-sz*(-0.5f+entry.getKey().i);
      s+="  \\draw[dot] ("+x+","+y+") circle (0.4" +
                ");\n";
    }
 
    s+="\\end{tikzpicture}\n";
    return s;
  }
 
  public SVGViewer spy(String caption,Colormap<T> colormap) {
    File tmp=null;
    try {
      tmp=File.createTempFile("aud-","svg");
    }
    catch (IOException e) {
      System.err.println("ERROR: "+e.getMessage());
      System.exit(-1);
    }
    tmp.deleteOnExit();
    renderSpySVG(tmp,colormap!=null ? colormap: new Colormap<T>());
 
    SVGViewer v=SVGViewer.displayWindow(tmp,caption!=null ? caption : "spy");
 
    return v;
  }
}