File: MatrixIO.java

package info (click to toggle)
libejml-java 0.41%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid, trixie
  • size: 7,376 kB
  • sloc: java: 82,734; python: 81; makefile: 22
file content (978 lines) | stat: -rw-r--r-- 35,841 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
/*
 * Copyright (c) 2021, Peter Abeles. All Rights Reserved.
 *
 * This file is part of Efficient Java Matrix Library (EJML).
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.ejml.ops;

import org.ejml.EjmlVersion;
import org.ejml.data.*;
import org.jetbrains.annotations.Nullable;
// import us.hebi.matlab.mat.ejml.Mat5Ejml;
// import us.hebi.matlab.mat.format.Mat5;
// import us.hebi.matlab.mat.types.MatFile;

import java.io.*;
import java.text.DecimalFormat;
import java.util.Arrays;
import java.util.Iterator;

import static java.nio.charset.StandardCharsets.UTF_8;
import static org.ejml.UtilEjml.fancyString;
import static org.ejml.UtilEjml.fancyStringF;

/**
 * Provides simple to use routines for reading and writing matrices to and from files.
 *
 * @author Peter Abeles
 */
public class MatrixIO {

    /** Default printf float format */
    public static final String DEFAULT_FLOAT_FORMAT = "%11.4E";
    /** Number of digits in pretty format */
    public static final int DEFAULT_LENGTH = 11;
    /** Specified the printf format used when printing out in Matlab format */
    public static String MATLAB_FORMAT = "%.8E";

    /**
     * Converts a text string in matlab format into a DDRM matrix
     */
    public static DMatrixRMaj matlabToDDRM( String text ) {
        // String all white space and the two [ ] characters
        text = text.replaceAll("(\\s+|\\[|\\])", "");
        String[] stringRows = text.split(";");
        String[] words = stringRows[0].split(",");
        DMatrixRMaj output = new DMatrixRMaj(stringRows.length, words.length);
        for (int row = 0; row < output.numRows; row++) {
            words = stringRows[row].split(",");
            if (words.length != output.numCols)
                throw new IllegalArgumentException("Inconsistent column lengths. " + output.numCols + " " + words.length);
            for (int col = 0; col < output.numCols; col++) {
                double value = Double.parseDouble(words[col]);
                output.set(row, col, value);
            }
        }
        return output;
    }

    /**
     * Converts a text string in matlab format into a DDRM matrix
     */
    public static FMatrixRMaj matlabToFDRM( String text ) {
        // String all white space and the two [ ] characters
        text = text.replaceAll("(\\s+|\\[|\\])", "");
        String[] stringRows = text.split(";");
        String[] words = stringRows[0].split(",");
        FMatrixRMaj output = new FMatrixRMaj(stringRows.length, words.length);
        for (int row = 0; row < output.numRows; row++) {
            words = stringRows[row].split(",");
            if (words.length != output.numCols)
                throw new IllegalArgumentException("Inconsistent column lengths. " + output.numCols + " " + words.length);
            for (int col = 0; col < output.numCols; col++) {
                float value = Float.parseFloat(words[col]);
                output.set(row, col, value);
            }
        }
        return output;
    }

    /**
     * Writes a stream using the Matrix Market Coordinate format.
     *
     * https://math.nist.gov/MatrixMarket/formats.html
     *
     * @param matrix The matrix to be written
     * @param floatFormat The format used by printf. "%.4e" is suggested
     * @param writer The writer
     */
    public static void saveMatrixMarketD( DMatrixSparse matrix, String floatFormat, Writer writer ) {
        PrintWriter out = new PrintWriter(writer);
        out.println("% Matrix Market Coordinate file written by EJML " + EjmlVersion.VERSION);
        out.println("% printf format used '" + floatFormat + "'");
        out.printf("%9d %9d %9d\n", matrix.getNumRows(), matrix.getNumCols(), matrix.getNonZeroLength());

        String lineFormat = "%9d %9d " + floatFormat + "\n";

        Iterator<DMatrixSparse.CoordinateRealValue> iter = matrix.createCoordinateIterator();
        while (iter.hasNext()) {
            DMatrixSparse.CoordinateRealValue val = iter.next();
            // matrix market is 1 indexed
            out.printf(lineFormat, val.row + 1, val.col + 1, val.value);
        }
        out.flush();
    }

    /**
     * Writes a stream using the Matrix Market Coordinate format.
     *
     * https://math.nist.gov/MatrixMarket/formats.html
     *
     * @param matrix The matrix to be written
     * @param floatFormat The format used by printf. "%.4e" is suggested
     * @param writer The writer
     */
    public static void saveMatrixMarketF( FMatrixSparse matrix, String floatFormat, Writer writer ) {
        PrintWriter out = new PrintWriter(writer);
        out.println("% Matrix Market Coordinate file written by EJML " + EjmlVersion.VERSION);
        out.println("% printf format used '" + floatFormat + "'");
        out.printf("%9d %9d %9d\n", matrix.getNumRows(), matrix.getNumCols(), matrix.getNonZeroLength());

        String lineFormat = "%9d %9d " + floatFormat + "\n";

        Iterator<FMatrixSparse.CoordinateRealValue> iter = matrix.createCoordinateIterator();
        while (iter.hasNext()) {
            FMatrixSparse.CoordinateRealValue val = iter.next();
            // matrix market is 1 indexed
            out.printf(lineFormat, val.row + 1, val.col + 1, val.value);
        }
        out.flush();
    }

    /**
     * Reads a stream in Matrix Market Coordinate format
     *
     * https://math.nist.gov/MatrixMarket/formats.html
     *
     * @param reader Input reader
     * @return Matrix in triplet format
     */
    public static DMatrixSparseTriplet loadMatrixMarketD( Reader reader ) {
        DMatrixSparseTriplet output = new DMatrixSparseTriplet();
        BufferedReader bufferedReader = new BufferedReader(reader);
        try {
            boolean hasHeader = false;
            String line = bufferedReader.readLine();
            while (line != null) {
                if (line.length() == 0 || line.charAt(0) == '%') {
                    line = bufferedReader.readLine();
                    continue;
                }
                String[] words = line.trim().split("\\s+");
                if (words.length != 3)
                    throw new IOException("Unexpected number of words: " + words.length);
                if (hasHeader) {
                    int row = Integer.parseInt(words[0]) - 1;
                    int col = Integer.parseInt(words[1]) - 1;
                    double value = Double.parseDouble(words[2]);
                    output.addItem(row, col, value);
                } else {
                    int rows = Integer.parseInt(words[0]);
                    int cols = Integer.parseInt(words[1]);
                    int nz_length = Integer.parseInt(words[2]);
                    output.reshape(rows, cols, nz_length);
                    hasHeader = true;
                }
                line = bufferedReader.readLine();
            }
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
        return output;
    }

    /**
     * Reads a stream in Matrix Market Coordinate format
     *
     * https://math.nist.gov/MatrixMarket/formats.html
     *
     * @param reader Input reader
     * @return Matrix in triplet format
     */
    public static FMatrixSparseTriplet loadMatrixMarketF( Reader reader ) {
        FMatrixSparseTriplet output = new FMatrixSparseTriplet();
        BufferedReader bufferedReader = new BufferedReader(reader);
        try {
            boolean hasHeader = false;
            String line = bufferedReader.readLine();
            while (line != null) {
                if (line.length() == 0 || line.charAt(0) == '%') {
                    line = bufferedReader.readLine();
                    continue;
                }
                String[] words = line.trim().split("\\s+");
                if (words.length != 3)
                    throw new IOException("Unexpected number of words: " + words.length);
                if (hasHeader) {
                    int row = Integer.parseInt(words[0]) - 1;
                    int col = Integer.parseInt(words[1]) - 1;
                    float value = Float.parseFloat(words[2]);
                    output.addItem(row, col, value);
                } else {
                    int rows = Integer.parseInt(words[0]);
                    int cols = Integer.parseInt(words[1]);
                    int nz_length = Integer.parseInt(words[2]);
                    output.reshape(rows, cols, nz_length);
                    hasHeader = true;
                }
                line = bufferedReader.readLine();
            }
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
        return output;
    }

    /**
     * Reads a stream in Matrix Market Coordinate format
     *
     * https://math.nist.gov/MatrixMarket/formats.html
     *
     * @param streamIn Input stream
     * @return Matrix in triplet format
     */
    public static FMatrixSparseTriplet loadMatrixMarketF( InputStream streamIn ) {
        FMatrixSparseTriplet output = new FMatrixSparseTriplet();
        BufferedReader reader = new BufferedReader(new InputStreamReader(streamIn, UTF_8));
        try {
            boolean hasHeader = false;
            String line = reader.readLine();
            while (line != null) {
                if (line.length() == 0 || line.charAt(0) == '%')
                    continue;
                String[] words = line.trim().split("\\s");
                if (words.length != 3)
                    throw new IOException("Unexpected number of words: " + words.length);
                if (hasHeader) {
                    int row = Integer.parseInt(words[0]);
                    int col = Integer.parseInt(words[1]);
                    float value = Float.parseFloat(words[2]);
                    output.addItem(row, col, value);
                } else {
                    int rows = Integer.parseInt(words[0]);
                    int cols = Integer.parseInt(words[1]);
                    int nz_length = Integer.parseInt(words[2]);
                    output.reshape(rows, cols, nz_length);
                    hasHeader = true;
                }
                line = reader.readLine();
            }
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
        return output;
    }

    /**
     * Saves a matrix to disk using MATLAB's MAT-File Format (Level 5) binary serialization.
     *
     * Notes:
     * * The matrix gets stored as a single root level entry named 'ejmlMatrix'
     * * {@link FMatrixSparseCSC} get stored as sparse double matrices
     *
     * See
     * <a href="https://github.com/HebiRobotics/MFL">MAT File Library</a>
     * <a href="https://www.mathworks.com/help/pdf_doc/matlab/matfile_format.pdf">matfile_format.pdf</a>
     *
     * @param A The matrix being saved.
     * @param fileName Name of the file its being saved at.
     */
    /* public static void saveMatlab( Matrix A, String fileName ) throws IOException {
        MflAccess.verifyEnabled();
        MflAccess.IO.saveMatlab(A, fileName);
    } */

    /**
     * Loads a {@link Matrix} which has been saved to file using MATLAB's MAT-File Format (Level 5) serialization.
     *
     * @param fileName The file being loaded. It is expected to contain a root level entry named 'ejmlMatrix'.
     * @return Matrix A matrix of the type that best matches the serialized data
     */
    /* public static <T extends Matrix> T loadMatlab( String fileName ) throws IOException {
        return loadMatlab(fileName, null);
    } */

    /**
     * Loads a {@link Matrix} which has been saved to file using MATLAB's MAT-File Format (Level 5) serialization.
     *
     * @param fileName The file being loaded. It is expected to contain a root level entry named 'ejmlMatrix'.
     * @param output Output Matrix. Automatically matched if null. Modified.
     * @return Matrix
     */
    /* public static <T extends Matrix> T loadMatlab( String fileName, @Nullable T output ) throws IOException {
        MflAccess.verifyEnabled();
        return MflAccess.IO.loadMatlab(fileName,output);
    } */

    /**
     * Lazily verify MFL availability without using reflections
     */
    static class MflAccess {

        private static void verifyEnabled() {
            if (!ENABLED) {
                throw new IllegalStateException("Missing dependency: add maven coordinates 'us.hebi.matlab.mat:mfl-ejml:0.5.7' or later. https://github.com/HebiRobotics/MFL");
            }
        }

        /* static {
            boolean foundInClasspath;
            try{
                @SuppressWarnings("unused")
                Class<Mat5Ejml> clazz = Mat5Ejml.class;
                foundInClasspath = true;
            }catch (NoClassDefFoundError cfe) {
                foundInClasspath = false;
            }
            ENABLED = foundInClasspath;
        } */

        private static final boolean ENABLED = false;

        /**
         * Load external library once we have verified that it exists
         */
        static class IO {

            /* public static void saveMatlab( Matrix A, String fileName ) throws IOException {
                MatFile mat = Mat5.newMatFile().addArray(ENTRY_NAME, Mat5Ejml.asArray(A));
                Mat5.writeToFile(mat, fileName);
            }

            public static <T extends Matrix> T loadMatlab( String fileName, @Nullable T output ) throws IOException {
                MatFile mat = Mat5.readFromFile(fileName);
                for (MatFile.Entry entry : mat.getEntries()) {
                    if (ENTRY_NAME.matches(entry.getName())) {
                        return Mat5Ejml.convert(entry.getValue(), output);
                    }
                }
                throw new IllegalArgumentException("File does not have expected entry: '" + ENTRY_NAME + "'");
            } */

            private static final String ENTRY_NAME = "ejmlMatrix";
        }

    }

    /**
     * Saves a matrix to disk using Java binary serialization.
     *
     * @param A The matrix being saved.
     * @param fileName Name of the file its being saved at.
     */
    public static void saveBin( DMatrix A, String fileName )
            throws IOException {
        FileOutputStream fileStream = new FileOutputStream(fileName);
        ObjectOutputStream stream = new ObjectOutputStream(fileStream);

        try {
            stream.writeObject(A);
            stream.flush();
        } finally {
            // clean up
            try {
                stream.close();
            } finally {
                fileStream.close();
            }
        }
    }

    /**
     * Loads a {@link DMatrix} which has been saved to file using Java binary
     * serialization.
     *
     * @deprecated
     * This will be removed in the future due to how unsafe readObject() is.
     *
     * @param fileName The file being loaded.
     * @return DMatrixRMaj
     */
    @Deprecated
    @SuppressWarnings("BanSerializableRead")
    public static <T extends DMatrix> T loadBin( String fileName )
            throws IOException {
        FileInputStream fileStream = new FileInputStream(fileName);
        ObjectInputStream stream = new ObjectInputStream(fileStream);

        T ret;
        try {
            ret = (T)stream.readObject();
            if (stream.available() != 0) {
                throw new RuntimeException("File not completely read?");
            }
        } catch (ClassNotFoundException e) {
            throw new RuntimeException(e);
        }

        stream.close();
        return (T)ret;
    }

    /**
     * Saves a matrix to disk using in a Column Space Value (CSV) format. For a
     * description of the format see {@link MatrixIO#loadCSV(String, boolean)}.
     *
     * @param A The matrix being saved.
     * @param fileName Name of the file its being saved at.
     */
    public static void saveDenseCSV( DMatrix A, String fileName )
            throws IOException {
        PrintStream fileStream = new PrintStream(fileName);

        fileStream.println(A.getNumRows() + " " + A.getNumCols() + " real");
        for (int i = 0; i < A.getNumRows(); i++) {
            for (int j = 0; j < A.getNumCols(); j++) {
                fileStream.print(A.get(i, j) + " ");
            }
            fileStream.println();
        }
        fileStream.close();
    }

    /**
     * Saves a matrix to disk using in a Column Space Value (CSV) format. For a
     * description of the format see {@link MatrixIO#loadCSV(String, boolean)}.
     *
     * @param A The matrix being saved.
     * @param fileName Name of the file its being saved at.
     */
    public static void saveSparseCSV( DMatrixSparseTriplet A, String fileName )
            throws IOException {
        PrintStream fileStream = new PrintStream(fileName);

        fileStream.println(A.getNumRows() + " " + A.getNumCols() + " " + A.nz_length + " real");
        for (int i = 0; i < A.nz_length; i++) {
            int row = A.nz_rowcol.data[i*2];
            int col = A.nz_rowcol.data[i*2 + 1];
            double value = A.nz_value.data[i];

            fileStream.println(row + " " + col + " " + value);
        }
        fileStream.close();
    }

    /**
     * Saves a matrix to disk using in a Column Space Value (CSV) format. For a
     * description of the format see {@link MatrixIO#loadCSV(String, boolean)}.
     *
     * @param A The matrix being saved.
     * @param fileName Name of the file its being saved at.
     */
    public static void saveSparseCSV( FMatrixSparseTriplet A, String fileName )
            throws IOException {
        PrintStream fileStream = new PrintStream(fileName);

        fileStream.println(A.getNumRows() + " " + A.getNumCols() + " " + A.nz_length + " real");
        for (int i = 0; i < A.nz_length; i++) {
            int row = A.nz_rowcol.data[i*2];
            int col = A.nz_rowcol.data[i*2 + 1];
            float value = A.nz_value.data[i];

            fileStream.println(row + " " + col + " " + value);
        }
        fileStream.close();
    }

    /**
     * Reads a matrix in which has been encoded using a Column Space Value (CSV)
     * file format. The number of rows and columns are read in on the first line. Then
     * each row is read in the subsequent lines.
     *
     * Works with dense and sparse matrices.
     *
     * @param fileName The file being loaded.
     * @return DMatrix
     */
    public static <T extends DMatrix> T loadCSV( String fileName, boolean doublePrecision )
            throws IOException {
        FileInputStream fileStream = new FileInputStream(fileName);
        ReadMatrixCsv csv = new ReadMatrixCsv(fileStream);

        T ret;
        if (doublePrecision)
            ret = csv.read64();
        else
            ret = csv.read32();

        fileStream.close();

        return ret;
    }

    /**
     * Reads a matrix in which has been encoded using a Column Space Value (CSV)
     * file format.  For a description of the format see {@link MatrixIO#loadCSV(String, boolean)}.
     *
     * @param fileName The file being loaded.
     * @param numRows number of rows in the matrix.
     * @param numCols number of columns in the matrix.
     * @return DMatrixRMaj
     */
    public static DMatrixRMaj loadCSV( String fileName, int numRows, int numCols )
            throws IOException {
        FileInputStream fileStream = new FileInputStream(fileName);
        ReadMatrixCsv csv = new ReadMatrixCsv(fileStream);

        DMatrixRMaj ret = csv.readDDRM(numRows, numCols);

        fileStream.close();

        return ret;
    }

    public static void printFancy( PrintStream out, DMatrix mat, int length ) {
        printTypeSize(out, mat);
        DecimalFormat format = new DecimalFormat("#");

        final int cols = mat.getNumCols();

        for (int row = 0; row < mat.getNumRows(); row++) {
            for (int col = 0; col < cols; col++) {
                out.print(fancyStringF(mat.get(row, col), format, length, 4));
                if (col != cols - 1)
                    out.print(" ");
            }
            out.println();
        }
    }

    public static void printFancy( PrintStream out, FMatrix mat, int length ) {
        printTypeSize(out, mat);
        DecimalFormat format = new DecimalFormat("#");

        final int cols = mat.getNumCols();

        for (int row = 0; row < mat.getNumRows(); row++) {
            for (int col = 0; col < cols; col++) {
                out.print(fancyStringF(mat.get(row, col), format, length, 4));
                if (col != cols - 1)
                    out.print(" ");
            }
            out.println();
        }
    }

    public static void printFancy( PrintStream out, ZMatrix mat, int length ) {
        printTypeSize(out, mat);
        DecimalFormat format = new DecimalFormat("#");

        StringBuilder builder = new StringBuilder(length);
        final int cols = mat.getNumCols();

        Complex_F64 c = new Complex_F64();
        for (int y = 0; y < mat.getNumRows(); y++) {
            for (int x = 0; x < cols; x++) {
                mat.get(y, x, c);
                String real = fancyString(c.real, format, length, 4);
                String img = fancyString(c.imaginary, format, length, 4);
                real = real + padSpace(builder, length - real.length());
                img = img + "i" + padSpace(builder, length - img.length());

                out.print(real + " + " + img);
                if (x < mat.getNumCols() - 1) {
                    out.print(" , ");
                }
            }
            out.println();
        }
    }

    public static void printFancy( PrintStream out, CMatrix mat, int length ) {
        printTypeSize(out, mat);
        DecimalFormat format = new DecimalFormat("#");

        StringBuilder builder = new StringBuilder(length);
        final int cols = mat.getNumCols();

        Complex_F32 c = new Complex_F32();
        for (int y = 0; y < mat.getNumRows(); y++) {
            for (int x = 0; x < cols; x++) {
                mat.get(y, x, c);
                String real = fancyString(c.real, format, length, 4);
                String img = fancyString(c.imaginary, format, length, 4);
                real = real + padSpace(builder, length - real.length());
                img = img + padSpace(builder, length - img.length());

                out.print(real + " + " + img + "i ");
                if (x < mat.getNumCols() - 1) {
                    out.print(" , ");
                }
            }
            out.println();
        }
    }

    private static String padSpace( StringBuilder builder, int length ) {
        builder.delete(0, builder.length());
        for (int i = 0; i < length; i++) {
            builder.append(' ');
        }
        return builder.toString();
    }

    public static void printFancy( PrintStream out, DMatrixSparseCSC m, int length ) {
        DecimalFormat format = new DecimalFormat("#");
        printTypeSize(out, m);

        char[] zero = new char[length];
        Arrays.fill(zero, ' ');
        zero[length/2] = '*';

        for (int row = 0; row < m.numRows; row++) {
            for (int col = 0; col < m.numCols; col++) {
                int index = m.nz_index(row, col);
                if (index >= 0)
                    out.print(fancyStringF(m.nz_values[index], format, length, 4));
                else
                    out.print(zero);
                if (col != m.numCols - 1)
                    out.print(" ");
            }
            out.println();
        }
    }

    public static void print( PrintStream out, Matrix mat ) {
        String format = DEFAULT_FLOAT_FORMAT;

        switch (mat.getType()) {
            case DDRM: print(out, (DMatrix)mat, format); break;
            case FDRM: print(out, (FMatrix)mat, format); break;
            case ZDRM: print(out, (ZMatrix)mat, format); break;
            case CDRM: print(out, (CMatrix)mat, format); break;
            case DSCC: print(out, (DMatrixSparseCSC)mat, format); break;
            case DTRIPLET: print(out, (DMatrixSparseTriplet)mat, format); break;
            case FSCC: print(out, (FMatrixSparseCSC)mat, format); break;
            case FTRIPLET: print(out, (FMatrixSparseTriplet)mat, format); break;
            default: throw new RuntimeException("Unknown type " + mat.getType());
        }
    }

    public static void print( PrintStream out, DMatrix mat ) {
        print(out, mat, DEFAULT_FLOAT_FORMAT);
    }

    /**
     * Prints the matrix out in a text format. The format is specified using notation from
     * {@link String#format(String, Object...)}. Unless the format is set to 'matlab' then it will print it out
     * in a format that's understood by Matlab. 'java' will print a java 2D array.
     *
     * @param out Output stream
     * @param mat Matrix to be printed
     * @param format printf style or 'matlab'
     */
    public static void print( PrintStream out, DMatrix mat, String format ) {
        if (format.equalsIgnoreCase("matlab")) {
            printMatlab(out, mat);
        } else if (format.equalsIgnoreCase("java")) {
            printJava(out, mat, format);
        } else {
            printTypeSize(out, mat);

            format += " ";

            for (int row = 0; row < mat.getNumRows(); row++) {
                for (int col = 0; col < mat.getNumCols(); col++) {
                    out.printf(format, mat.get(row, col));
                }
                out.println();
            }
        }
    }

    public static void printMatlab( PrintStream out, DMatrix mat ) {
        out.print("[ ");

        for (int row = 0; row < mat.getNumRows(); row++) {
            for (int col = 0; col < mat.getNumCols(); col++) {
                out.printf("%.12E", mat.get(row, col));
                if (col + 1 < mat.getNumCols()) {
                    out.print(" , ");
                }
            }
            if (row + 1 < mat.getNumRows())
                out.println(" ;");
            else
                out.println(" ]");
        }
    }

    public static void printMatlab( PrintStream out, FMatrix mat ) {
        out.print("[ ");

        for (int row = 0; row < mat.getNumRows(); row++) {
            for (int col = 0; col < mat.getNumCols(); col++) {
                out.printf(MATLAB_FORMAT, mat.get(row, col));
                if (col + 1 < mat.getNumCols()) {
                    out.print(" , ");
                }
            }
            if (row + 1 < mat.getNumRows())
                out.println(" ;");
            else
                out.println(" ]");
        }
    }

    /**
     * Prints the matrix out in a text format. The format is specified using notation from
     * {@link String#format(String, Object...)}. Unless the format is set to 'matlab' then it will print it out
     * in a format that's understood by Matlab.
     *
     * @param out Output stream
     * @param m Matrix to be printed
     * @param format printf style or 'matlab'
     */
    public static void print( PrintStream out, DMatrixSparseCSC m, String format ) {
        if (format.equalsIgnoreCase("matlab")) {
            printMatlab(out, m);
        } else {
            printTypeSize(out, m);

            int length = String.format(format, -1.1123).length();
            char[] zero = new char[length];
            Arrays.fill(zero, ' ');
            zero[length/2] = '*';

            for (int row = 0; row < m.numRows; row++) {
                for (int col = 0; col < m.numCols; col++) {
                    int index = m.nz_index(row, col);
                    if (index >= 0)
                        out.printf(format, m.nz_values[index]);
                    else
                        out.print(zero);
                    if (col != m.numCols - 1)
                        out.print(" ");
                }
                out.println();
            }
        }
    }

    public static void print( PrintStream out, FMatrixSparseCSC m, String format ) {
        if (format.equalsIgnoreCase("matlab")) {
            printMatlab(out, m);
        } else {
            printTypeSize(out, m);

            int length = String.format(format, -1.1123).length();
            char[] zero = new char[length];
            Arrays.fill(zero, ' ');
            zero[length/2] = '*';

            for (int row = 0; row < m.numRows; row++) {
                for (int col = 0; col < m.numCols; col++) {
                    int index = m.nz_index(row, col);
                    if (index >= 0)
                        out.printf(format, m.nz_values[index]);
                    else
                        out.print(zero);
                    if (col != m.numCols - 1)
                        out.print(" ");
                }
                out.println();
            }
        }
    }

    public static void print( PrintStream out, DMatrixSparseTriplet m, String format ) {
        printTypeSize(out, m);

        for (int row = 0; row < m.numRows; row++) {
            for (int col = 0; col < m.numCols; col++) {
                int index = m.nz_index(row, col);
                if (index >= 0)
                    out.printf(format, m.nz_value.data[index]);
                else
                    out.print("   *  ");
                if (col != m.numCols - 1)
                    out.print(" ");
            }
            out.println();
        }
    }

    public static void print( PrintStream out, FMatrixSparseTriplet m, String format ) {
        printTypeSize(out, m);

        for (int row = 0; row < m.numRows; row++) {
            for (int col = 0; col < m.numCols; col++) {
                int index = m.nz_index(row, col);
                if (index >= 0)
                    out.printf(format, m.nz_value.data[index]);
                else
                    out.print("   *  ");
                if (col != m.numCols - 1)
                    out.print(" ");
            }
            out.println();
        }
    }

    public static void printJava( PrintStream out, DMatrix mat, String format ) {

        String type = mat.getType().getBits() == 64 ? "double" : "float";

        out.println("new " + type + "[][]{");

        format += " ";

        for (int y = 0; y < mat.getNumRows(); y++) {
            out.print("{");
            for (int x = 0; x < mat.getNumCols(); x++) {
                out.printf(format, mat.get(y, x));
                if (x + 1 < mat.getNumCols())
                    out.print(", ");
            }
            if (y + 1 < mat.getNumRows())
                out.println("},");
            else
                out.println("}};");
        }
    }

    public static void print( PrintStream out, FMatrix mat ) {
        print(out, mat, DEFAULT_FLOAT_FORMAT);
    }

    public static void print( PrintStream out, FMatrix mat, String format ) {
        if (format.equalsIgnoreCase("matlab")) {
            printMatlab(out, mat);
        } else if (format.equalsIgnoreCase("java")) {
            printJava(out, mat, format);
        } else {
            printTypeSize(out, mat);

            format += " ";

            for (int row = 0; row < mat.getNumRows(); row++) {
                for (int col = 0; col < mat.getNumCols(); col++) {
                    out.printf(format, mat.get(row, col));
                }
                out.println();
            }
        }
    }

    public static void print( PrintStream out, DMatrix mat, String format,
                              int row0, int row1, int col0, int col1 ) {
        out.println("Type = submatrix , rows " + row0 + " to " + row1 + "  columns " + col0 + " to " + col1);

        format += " ";

        for (int y = row0; y < row1; y++) {
            for (int x = col0; x < col1; x++) {
                out.printf(format, mat.get(y, x));
            }
            out.println();
        }
    }

    public static void printJava( PrintStream out, FMatrix mat, String format ) {
        String type = mat.getType().getBits() == 64 ? "double" : "float";

        out.println("new " + type + "[][]{");

        format += " ";

        for (int y = 0; y < mat.getNumRows(); y++) {
            out.print("{");
            for (int x = 0; x < mat.getNumCols(); x++) {
                out.printf(format, mat.get(y, x));
                if (x + 1 < mat.getNumCols())
                    out.print(", ");
            }
            if (y + 1 < mat.getNumRows())
                out.println("},");
            else
                out.println("}};");
        }
    }

    public static void print( PrintStream out, FMatrix mat, String format,
                              int row0, int row1, int col0, int col1 ) {
        out.println("Type = submatrix , rows " + row0 + " to " + row1 + "  columns " + col0 + " to " + col1);

        format = format + " + " + format + "i";

        for (int y = row0; y < row1; y++) {
            for (int x = col0; x < col1; x++) {
                out.printf(format, mat.get(y, x));
            }
            out.println();
        }
    }

    public static void print( PrintStream out, ZMatrix mat, String format ) {
        printTypeSize(out, mat);

        format = format + " + " + format + "i";

        Complex_F64 c = new Complex_F64();
        for (int y = 0; y < mat.getNumRows(); y++) {
            for (int x = 0; x < mat.getNumCols(); x++) {
                mat.get(y, x, c);
                out.printf(format, c.real, c.imaginary);
                if (x < mat.getNumCols() - 1) {
                    out.print(" , ");
                }
            }
            out.println();
        }
    }

    private static void printTypeSize( PrintStream out, Matrix mat ) {
        if (mat instanceof MatrixSparse) {
            MatrixSparse m = (MatrixSparse)mat;
            out.println("Type = " + getMatrixType(mat) + " , rows = " + mat.getNumRows() +
                    " , cols = " + mat.getNumCols() + " , nz_length = " + m.getNonZeroLength());
        } else {
            out.println("Type = " + getMatrixType(mat) + " , rows = " + mat.getNumRows() + " , cols = " + mat.getNumCols());
        }
    }

    public static void print( PrintStream out, CMatrix mat, String format ) {
        printTypeSize(out, mat);

        format += " ";

        Complex_F32 c = new Complex_F32();
        for (int y = 0; y < mat.getNumRows(); y++) {
            for (int x = 0; x < mat.getNumCols(); x++) {
                mat.get(y, x, c);
                out.printf(format, c.real, c.imaginary);
                if (x < mat.getNumCols() - 1) {
                    out.print(" , ");
                }
            }
            out.println();
        }
    }

    private static String getMatrixType( Matrix mat ) {
        String type;
        if (mat.getType() == MatrixType.UNSPECIFIED) {
            type = mat.getClass().getSimpleName();
        } else {
            type = mat.getType().name();
        }
        return type;
    }

//    public static void main( String []args ) {
//        Random rand = new Random(234234);
//        DMatrixRMaj A = RandomMatrices.createRandom(50,70,rand);
//
//        SingularValueDecomposition decomp = DecompositionFactory.svd();
//
//        decomp.decompose(A);
//
//        displayMatrix(A,"Original");
//        displayMatrix(decomp.getU(false),"U");
//        displayMatrix(decomp.getV(false),"V");
//        displayMatrix(decomp.getW(null),"W");
//    }
}