-
Notifications
You must be signed in to change notification settings - Fork 62
/
matrix_vector.f90
6636 lines (5932 loc) · 290 KB
/
matrix_vector.f90
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
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
!> \file
!> \author Chris Bradley
!> \brief This module contains all routines dealing with (non-distributed) matrix and vectors types.
!>
!> \section LICENSE
!>
!> Version: MPL 1.1/GPL 2.0/LGPL 2.1
!>
!> The contents of this file are subject to the Mozilla Public License
!> Version 1.1 (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.mozilla.org/MPL/
!>
!> Software distributed under the License is distributed on an "AS IS"
!> basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
!> License for the specific language governing rights and limitations
!> under the License.
!>
!> The Original Code is OpenCMISS
!>
!> The Initial Developer of the Original Code is University of Auckland,
!> Auckland, New Zealand, the University of Oxford, Oxford, United
!> Kingdom and King's College, London, United Kingdom. Portions created
!> by the University of Auckland, the University of Oxford and King's
!> College, London are Copyright (C) 2007-2010 by the University of
!> Auckland, the University of Oxford and King's College, London.
!> All Rights Reserved.
!>
!> Contributor(s):
!>
!> Alternatively, the contents of this file may be used under the terms of
!> either the GNU General Public License Version 2 or later (the "GPL"), or
!> the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
!> in which case the provisions of the GPL or the LGPL are applicable instead
!> of those above. If you wish to allow use of your version of this file only
!> under the terms of either the GPL or the LGPL, and not to allow others to
!> use your version of this file under the terms of the MPL, indicate your
!> decision by deleting the provisions above and replace them with the notice
!> and other provisions required by the GPL or the LGPL. If you do not delete
!> the provisions above, a recipient may use your version of this file under
!> the terms of any one of the MPL, the GPL or the LGPL.
!>
!> \section MatrixVector_MatrixStorageStructures MATRIX STORAGE STRUCTURES
!> The matrix storage structures used are governed by the STORAGE parameter associated with the array. If STORAGE is
!> MATRIX_BLOCK_STORAGE_TYPE the matrix is not sparse and the the non-sparse matrix dimension M is used to calculate
!> the matrix storage locations. If storage is MATRIX_DIAGONAL_STORAGE_TYPE then only the matrix diagonal is stored.
!> If storage is MATRIX_COLUMN_MAJOR_STORAGE_TYPE the matrix is not sparse and the non-sparse
!> matrix dimension MAX_M (>=M) is used to calcualte the matrix storage locations. If storage is
!> MATRIX_ROW_MAJOR_STORAGE_TYPE the matrix is not sparse and the non-sparse matrix dimension MAX_N (>=N) is used to
!> calcualte the matrix storage locations. If STORAGE is MATRIX_COMPRESSED_ROW_STORAGE_TYPE the matrix has compressed row
!> storage/sparsity (see below) and the sparsity structure arrays ROW_INDICES and COLUMN_INDICES are used for the
!> storage location calculation. If STORAGE is MATRIX_COMPRESSED_COLUMN_STORAGE_TYPE the matrix has compressed column
!> storage/sparsity (see below) and the sparsity structure arrays ROW_INDICES and COLUMN_INDICES are used for the
!> storage location calculation. If STORAGE is MATRIX_ROW_COLUMN_STORAGE_TYPE the matrix has row column
!> storage/sparsity (see below) and the sparsity structure arrays ROW_INDICES and COLUMN_INDICES are used for the
!> storage location calculation.
!>
!> \subsection MatrixVector_CompressedRowStorage COMPRESSED-ROW STORAGE:
!>
!> The storage structure scheme is based on storing a MxN matrix as a one dimensional array of length SIZE
!> (=NUMBER_NON_ZEROS) (where NUMBER_NON_ZEROS=sxMxN, s is the sparsity of the array) that stores only the non-zero
!> elements of the matrix. Two additional arrays ROW_INDICES and COLUMN_INDICES store the positions of the non-zero
!> elements. ROW_INDICES is of length M+1 and COLUMN is of length NUMBER_NON_ZEROS. ROW_INDICES(i) stores the position
!> in COLUMN_INDICES of the start of row i. The M+1 position of ROW_INDICES stores the size of COLUMN_INDICES+1 i.e.,
!> NUMBER_NON_ZEROS+1. The number of non-zero elements in row i can be found from ROW_INDICES(i+1)-ROW_INDICES(i).
!> COLUMN_INDICES(nz) gives the column number for non-zero element nz. See also COMPRESSED-COLUMN storage.
!>
!> Example of the compressed-row storage scheme on a NxN matrix (N=6). Here the sparsity is 8/36 or 22%
!> \verbatim
!>
!> GX 1 2 3 4 5 6
!> ____________ DATA(nz)
!> 1| 0 A 0 B 0 0 A B C D E F G H
!> 2| 0 0 C 0 0 0
!> 3| 0 0 0 0 D E ROW_INDICES(i)
!> 4| F 0 0 0 0 0 1 3 4 6 7 8 9
!> 5| 0 0 G 0 0 0 COLUMN_INDICES(i)
!> 6| 0 0 0 0 0 H 2 4 3 5 6 1 3 6
!>
!> \endverbatim
!>
!> \subsection MatrixVector_CompressedColumnStorage COMPRESSED-COLUMN STORAGE:
!>
!> The storage structure scheme is based on storing a MxN matrix as a one dimensional array of length SIZE
!> (=NUMBER_NON_ZEROS) (where NUMBER_NON_ZEROS=sxMxN, s is the sparsity of the array) that stores only the non-zero
!> elements of the matrix. Two additional arrays ROW_INDICES and COLUMN_INDICES store the positions of the non-zero
!> elements. ROW_INDICES is of length NUMBER_NON_ZEROS and COLUMN is of length N+1. COLUMN_INDICES(j) stores the position
!> in ROW_INDICES of the start of column j. The N+1 position of COLUMN_INDICES stores the size of ROW_INDICES+1 i.e.,
!> NUMBER_NON_ZEROS+1. The number of non-zero elements in column j can be found from COLUMN_INDICES(j+1)-COLUMN_INDICES(j).
!> ROW_INDICES(nz) gives the row number for non-zero element nz. See also COMPRESSED-ROW storage.
!>
!> Example of compressed-column storage scheme on a NxN matrix (N=6). Here the sparsity is 8/36 or 22%
!> \verbatim
!>
!> GX 1 2 3 4 5 6
!> ____________ DATA(nz)
!> 1| 0 A 0 B 0 0 F A C G B D E H
!> 2| 0 0 C 0 0 0
!> 3| 0 0 0 0 D E ROW_INDICES(i)
!> 4| F 0 0 0 0 0 4 1 2 5 1 3 3 6
!> 5| 0 0 G 0 0 0 COLUMN_INDICES(i)
!> 6| 0 0 0 0 0 H 1 2 3 5 6 7 9
!>
!> \endverbatim
!>
!> \subsection MatrixVector_RowColumnStorage ROW-COLUMN STORAGE:
!>
!> The storage structure scheme is based on storing a MxN matrix as a one dimensional array of length SIZE
!> (=NUMBER_NON_ZEROS) (where NUMBER_NON_ZEROS=sxMxN, s is the sparsity of the array) that stores only the non-zero
!> elements of the matrix. Two additional arrays ROW_INDICES and COLUMN_INDICES store the positions of the non-zero
!> elements. Both ROW_INDICES and COLUMN_INDICES are of length NUMBER_NON_ZEROS. ROW_INDICES(nz) gives the row number for
!> non-zero element nz and COLUMN_INDICES(nz) gives the column number for non-zero element nz.
!>
!> Example of row-column storage scheme on a NxN matrix (N=6). Here the sparsity is 8/36 or 22%
!> \verbatim
!>
!> GX 1 2 3 4 5 6
!> ____________ DATA(nz)
!> 1| 0 A 0 B 0 0 A B C D E F G H
!> 2| 0 0 C 0 0 0
!> 3| 0 0 0 0 D E ROW_INDICES(i)
!> 4| F 0 0 0 0 0 1 1 2 3 3 4 5 6
!> 5| 0 0 G 0 0 0 COLUMN_INDICES(i)
!> 6| 0 0 0 0 0 H 2 4 3 5 6 1 3 6
!>
!> \endverbatim
!>This module contains all routines dealing with (non-distributed) matrix and vectors types.
MODULE MatrixVector
USE BaseRoutines
USE CONSTANTS
USE INPUT_OUTPUT
USE ISO_VARYING_STRING
USE KINDS
USE LISTS
USE STRINGS
USE TYPES
USE LINKEDLIST_ROUTINES
#include "macros.h"
IMPLICIT NONE
!PRIVATE
!Module parameters
!> \addtogroup MatrixVector_DataTypes MatrixVector::DataTypes
!> \brief Matrix vector data types
!> \see MatrixVector
!>@{
INTEGER(INTG), PARAMETER :: MATRIX_VECTOR_INTG_TYPE=INTEGER_TYPE !<Integer matrix-vector data type \see MatrixVector_DataTypes,MatrixVector
INTEGER(INTG), PARAMETER :: MATRIX_VECTOR_SP_TYPE=SINGLE_REAL_TYPE !<Single precision real matrix-vector data type \see MatrixVector_DataTypes,MatrixVector
INTEGER(INTG), PARAMETER :: MATRIX_VECTOR_DP_TYPE=DOUBLE_REAL_TYPE !<Double precision real matrix-vector data type \see MatrixVector_DataTypes,MatrixVector
INTEGER(INTG), PARAMETER :: MATRIX_VECTOR_L_TYPE=LOGICAL_TYPE !<Logical matrix-vector data type \see MatrixVector_DataTypes,MatrixVector
INTEGER(INTG), PARAMETER :: MATRIX_VECTOR_SPC_TYPE=SINGLE_COMPLEX_TYPE !<Single precision complex matrix-vector data type \see MatrixVector_DataTypes,MatrixVector
INTEGER(INTG), PARAMETER :: MATRIX_VECTOR_DPC_TYPE=DOUBLE_COMPLEX_TYPE !<Double precision complex matrix-vector data type \see MatrixVector_DataTypes,MatrixVector
!>@}
!> \addtogroup MatrixVector_StorageTypes MatrixVector::StorageTypes
!> \brief Matrix-vector storage type parameters
!> \see MatrixVector_MatrixStorageStructures,MatrixVector
!>@{
INTEGER(INTG), PARAMETER :: MATRIX_BLOCK_STORAGE_TYPE=0 !<Matrix block storage type \see MatrixVector_StorageTypes,MatrixVector
INTEGER(INTG), PARAMETER :: MATRIX_DIAGONAL_STORAGE_TYPE=1 !<Matrix diagonal storage type \see MatrixVector_StorageTypes,MatrixVector
INTEGER(INTG), PARAMETER :: MATRIX_COLUMN_MAJOR_STORAGE_TYPE=2 !<Matrix column major storage type \see MatrixVector_StorageTypes,MatrixVector
INTEGER(INTG), PARAMETER :: MATRIX_ROW_MAJOR_STORAGE_TYPE=3 !<Matrix row major storage type \see MatrixVector_StorageTypes,MatrixVector
INTEGER(INTG), PARAMETER :: MATRIX_COMPRESSED_ROW_STORAGE_TYPE=4 !<Matrix compressed row storage type \see MatrixVector_StorageTypes,MatrixVector
INTEGER(INTG), PARAMETER :: MATRIX_COMPRESSED_COLUMN_STORAGE_TYPE=5 !<Matrix compressed column storage type \see MatrixVector_StorageTypes,MatrixVector
INTEGER(INTG), PARAMETER :: MATRIX_ROW_COLUMN_STORAGE_TYPE=6 !<Matrix row-column storage type \see MatrixVector_StorageTypes,MatrixVector
!>@}
!> \addtogroup MatrixVector_SymmetryTypes MatrixVector::SymmetryTypes
!> \brief Matrix-vector storage type parameters
!> \see MatrixVector_MatrixStorageStructures,MatrixVector
!>@{
INTEGER(INTG), PARAMETER :: MATRIX_SYMMETRIC_TYPE=0 !<Matrix is symmetric \see MatrixVector_SymmetryTypes,MatrixVector
INTEGER(INTG), PARAMETER :: MATRIX_HERMITIAN_TYPE=1 !<Matrix is Hermitian (complex symmetric) \see MatrixVector_SymmetryTypes,MatrixVector
INTEGER(INTG), PARAMETER :: MATRIX_SKEW_SYMMETRIC_TYPE=2 !<Matrix is skew-symmetric \see MatrixVector_SymmetryTypes,MatrixVector
INTEGER(INTG), PARAMETER :: MATRIX_UNSYMMETRIC_TYPE=3 !<Matrix is unsymmetric \see MatrixVector_SymmetryTypes,MatrixVector
!>@}
INTEGER(INTG), PARAMETER :: bisectionToLinearSearchThreshold=10 !<Threshold for transition from bisection to linear search.
!Module types
!Matrix types
!Module variables
INTEGER(INTG), SAVE :: MATRIX_VECTOR_ID=1
!Interfaces
INTERFACE MATRIX_ALL_VALUES_SET
MODULE PROCEDURE MATRIX_ALL_VALUES_SET_INTG
MODULE PROCEDURE MATRIX_ALL_VALUES_SET_SP
MODULE PROCEDURE MATRIX_ALL_VALUES_SET_DP
MODULE PROCEDURE MATRIX_ALL_VALUES_SET_L
END INTERFACE MATRIX_ALL_VALUES_SET
INTERFACE Matrix_AllValuesSet
MODULE PROCEDURE MATRIX_ALL_VALUES_SET_INTG
MODULE PROCEDURE MATRIX_ALL_VALUES_SET_SP
MODULE PROCEDURE MATRIX_ALL_VALUES_SET_DP
MODULE PROCEDURE MATRIX_ALL_VALUES_SET_L
END INTERFACE Matrix_AllValuesSet
INTERFACE Matrix_CreateFinish
MODULE PROCEDURE MATRIX_CREATE_FINISH
END INTERFACE Matrix_CreateFinish
INTERFACE Matrix_CreateStart
MODULE PROCEDURE MATRIX_CREATE_START
END INTERFACE Matrix_CreateStart
INTERFACE MATRIX_DATA_GET
MODULE PROCEDURE MATRIX_DATA_GET_INTG
MODULE PROCEDURE MATRIX_DATA_GET_SP
MODULE PROCEDURE MATRIX_DATA_GET_DP
MODULE PROCEDURE MATRIX_DATA_GET_L
END INTERFACE MATRIX_DATA_GET
INTERFACE Matrix_DataGet
MODULE PROCEDURE MATRIX_DATA_GET_INTG
MODULE PROCEDURE MATRIX_DATA_GET_SP
MODULE PROCEDURE MATRIX_DATA_GET_DP
MODULE PROCEDURE MATRIX_DATA_GET_L
END INTERFACE Matrix_DataGet
INTERFACE Matrix_DataTypeSet
MODULE PROCEDURE MATRIX_DATA_TYPE_SET
END INTERFACE Matrix_DataTypeSet
INTERFACE Matrix_MaxColumnsPerRowGet
MODULE PROCEDURE MATRIX_MAX_COLUMNS_PER_ROW_GET
END INTERFACE Matrix_MaxColumnsPerRowGet
INTERFACE Matrix_NumberOfNonZerosGet
MODULE PROCEDURE MATRIX_NUMBER_NON_ZEROS_GET
END INTERFACE Matrix_NumberOfNonZerosGet
INTERFACE Matrix_NumberOfNonZerosSet
MODULE PROCEDURE MATRIX_NUMBER_NON_ZEROS_SET
END INTERFACE Matrix_NumberOfNonZerosSet
INTERFACE Matrix_MaxSizeSet
MODULE PROCEDURE MATRIX_MAX_SIZE_SET
END INTERFACE Matrix_MaxSizeSet
INTERFACE Matrix_SizeSet
MODULE PROCEDURE MATRIX_SIZE_SET
END INTERFACE Matrix_SizeSet
INTERFACE Matrix_StorageLocationFind
MODULE PROCEDURE MATRIX_STORAGE_LOCATION_FIND
END INTERFACE Matrix_StorageLocationFind
INTERFACE Matrix_StorageLocationsGet
MODULE PROCEDURE MATRIX_STORAGE_LOCATIONS_GET
END INTERFACE Matrix_StorageLocationsGet
INTERFACE Matrix_StorageLocationsSet
MODULE PROCEDURE MATRIX_STORAGE_LOCATIONS_SET
END INTERFACE Matrix_StorageLocationsSet
INTERFACE Matrix_StorageTypeGet
MODULE PROCEDURE MATRIX_STORAGE_TYPE_GET
END INTERFACE Matrix_StorageTypeGet
INTERFACE Matrix_StorageTypeSet
MODULE PROCEDURE MATRIX_STORAGE_TYPE_SET
END INTERFACE Matrix_StorageTypeSet
INTERFACE MATRIX_VALUES_ADD
MODULE PROCEDURE MATRIX_VALUES_ADD_INTG
MODULE PROCEDURE MATRIX_VALUES_ADD_INTG1
MODULE PROCEDURE MATRIX_VALUES_ADD_INTG2
MODULE PROCEDURE MATRIX_VALUES_ADD_SP
MODULE PROCEDURE MATRIX_VALUES_ADD_SP1
MODULE PROCEDURE MATRIX_VALUES_ADD_SP2
MODULE PROCEDURE MATRIX_VALUES_ADD_DP
MODULE PROCEDURE MATRIX_VALUES_ADD_DP1
MODULE PROCEDURE MATRIX_VALUES_ADD_DP2
MODULE PROCEDURE MATRIX_VALUES_ADD_L
MODULE PROCEDURE MATRIX_VALUES_ADD_L1
MODULE PROCEDURE MATRIX_VALUES_ADD_L2
END INTERFACE MATRIX_VALUES_ADD
INTERFACE Matrix_ValuesAdd
MODULE PROCEDURE MATRIX_VALUES_ADD_INTG
MODULE PROCEDURE MATRIX_VALUES_ADD_INTG1
MODULE PROCEDURE MATRIX_VALUES_ADD_INTG2
MODULE PROCEDURE MATRIX_VALUES_ADD_SP
MODULE PROCEDURE MATRIX_VALUES_ADD_SP1
MODULE PROCEDURE MATRIX_VALUES_ADD_SP2
MODULE PROCEDURE MATRIX_VALUES_ADD_DP
MODULE PROCEDURE MATRIX_VALUES_ADD_DP1
MODULE PROCEDURE MATRIX_VALUES_ADD_DP2
MODULE PROCEDURE MATRIX_VALUES_ADD_L
MODULE PROCEDURE MATRIX_VALUES_ADD_L1
MODULE PROCEDURE MATRIX_VALUES_ADD_L2
END INTERFACE Matrix_ValuesAdd
INTERFACE MATRIX_VALUES_GET
MODULE PROCEDURE MATRIX_VALUES_GET_INTG
MODULE PROCEDURE MATRIX_VALUES_GET_INTG1
MODULE PROCEDURE MATRIX_VALUES_GET_INTG2
MODULE PROCEDURE MATRIX_VALUES_GET_SP
MODULE PROCEDURE MATRIX_VALUES_GET_SP1
MODULE PROCEDURE MATRIX_VALUES_GET_SP2
MODULE PROCEDURE MATRIX_VALUES_GET_DP
MODULE PROCEDURE MATRIX_VALUES_GET_DP1
MODULE PROCEDURE MATRIX_VALUES_GET_DP2
MODULE PROCEDURE MATRIX_VALUES_GET_L
MODULE PROCEDURE MATRIX_VALUES_GET_L1
MODULE PROCEDURE MATRIX_VALUES_GET_L2
END INTERFACE MATRIX_VALUES_GET
INTERFACE Matrix_ValuesGet
MODULE PROCEDURE MATRIX_VALUES_GET_INTG
MODULE PROCEDURE MATRIX_VALUES_GET_INTG1
MODULE PROCEDURE MATRIX_VALUES_GET_INTG2
MODULE PROCEDURE MATRIX_VALUES_GET_SP
MODULE PROCEDURE MATRIX_VALUES_GET_SP1
MODULE PROCEDURE MATRIX_VALUES_GET_SP2
MODULE PROCEDURE MATRIX_VALUES_GET_DP
MODULE PROCEDURE MATRIX_VALUES_GET_DP1
MODULE PROCEDURE MATRIX_VALUES_GET_DP2
MODULE PROCEDURE MATRIX_VALUES_GET_L
MODULE PROCEDURE MATRIX_VALUES_GET_L1
MODULE PROCEDURE MATRIX_VALUES_GET_L2
END INTERFACE Matrix_ValuesGet
INTERFACE MATRIX_VALUES_SET
MODULE PROCEDURE MATRIX_VALUES_SET_INTG
MODULE PROCEDURE MATRIX_VALUES_SET_INTG1
MODULE PROCEDURE MATRIX_VALUES_SET_INTG2
MODULE PROCEDURE MATRIX_VALUES_SET_SP
MODULE PROCEDURE MATRIX_VALUES_SET_SP1
MODULE PROCEDURE MATRIX_VALUES_SET_SP2
MODULE PROCEDURE MATRIX_VALUES_SET_DP
MODULE PROCEDURE MATRIX_VALUES_SET_DP1
MODULE PROCEDURE MATRIX_VALUES_SET_DP2
MODULE PROCEDURE MATRIX_VALUES_SET_L
MODULE PROCEDURE MATRIX_VALUES_SET_L1
MODULE PROCEDURE MATRIX_VALUES_SET_L2
END INTERFACE MATRIX_VALUES_SET
INTERFACE Matrix_ValuesSet
MODULE PROCEDURE MATRIX_VALUES_SET_INTG
MODULE PROCEDURE MATRIX_VALUES_SET_INTG1
MODULE PROCEDURE MATRIX_VALUES_SET_INTG2
MODULE PROCEDURE MATRIX_VALUES_SET_SP
MODULE PROCEDURE MATRIX_VALUES_SET_SP1
MODULE PROCEDURE MATRIX_VALUES_SET_SP2
MODULE PROCEDURE MATRIX_VALUES_SET_DP
MODULE PROCEDURE MATRIX_VALUES_SET_DP1
MODULE PROCEDURE MATRIX_VALUES_SET_DP2
MODULE PROCEDURE MATRIX_VALUES_SET_L
MODULE PROCEDURE MATRIX_VALUES_SET_L1
MODULE PROCEDURE MATRIX_VALUES_SET_L2
END INTERFACE Matrix_ValuesSet
INTERFACE VECTOR_ALL_VALUES_SET
MODULE PROCEDURE VECTOR_ALL_VALUES_SET_INTG
MODULE PROCEDURE VECTOR_ALL_VALUES_SET_SP
MODULE PROCEDURE VECTOR_ALL_VALUES_SET_DP
MODULE PROCEDURE VECTOR_ALL_VALUES_SET_L
END INTERFACE VECTOR_ALL_VALUES_SET
INTERFACE Vector_AllValuesSet
MODULE PROCEDURE VECTOR_ALL_VALUES_SET_INTG
MODULE PROCEDURE VECTOR_ALL_VALUES_SET_SP
MODULE PROCEDURE VECTOR_ALL_VALUES_SET_DP
MODULE PROCEDURE VECTOR_ALL_VALUES_SET_L
END INTERFACE Vector_AllValuesSet
INTERFACE Vector_CreateFinish
MODULE PROCEDURE VECTOR_CREATE_FINISH
END INTERFACE Vector_CreateFinish
INTERFACE Vector_CreateStart
MODULE PROCEDURE VECTOR_CREATE_START
END INTERFACE Vector_CreateStart
INTERFACE VECTOR_DATA_GET
MODULE PROCEDURE VECTOR_DATA_GET_INTG
MODULE PROCEDURE VECTOR_DATA_GET_SP
MODULE PROCEDURE VECTOR_DATA_GET_DP
MODULE PROCEDURE VECTOR_DATA_GET_L
END INTERFACE VECTOR_DATA_GET
INTERFACE Vector_DataGet
MODULE PROCEDURE VECTOR_DATA_GET_INTG
MODULE PROCEDURE VECTOR_DATA_GET_SP
MODULE PROCEDURE VECTOR_DATA_GET_DP
MODULE PROCEDURE VECTOR_DATA_GET_L
END INTERFACE Vector_DataGet
INTERFACE Vector_DataTypeSet
MODULE PROCEDURE VECTOR_DATA_TYPE_SET
END INTERFACE Vector_DataTypeSet
INTERFACE Vector_SizeSet
MODULE PROCEDURE VECTOR_SIZE_SET
END INTERFACE Vector_SizeSet
INTERFACE VECTOR_VALUES_GET
MODULE PROCEDURE VECTOR_VALUES_GET_INTG
MODULE PROCEDURE VECTOR_VALUES_GET_INTG1
MODULE PROCEDURE VECTOR_VALUES_GET_SP
MODULE PROCEDURE VECTOR_VALUES_GET_SP1
MODULE PROCEDURE VECTOR_VALUES_GET_DP
MODULE PROCEDURE VECTOR_VALUES_GET_DP1
MODULE PROCEDURE VECTOR_VALUES_GET_L
MODULE PROCEDURE VECTOR_VALUES_GET_L1
END INTERFACE VECTOR_VALUES_GET
INTERFACE Vector_ValuesGet
MODULE PROCEDURE VECTOR_VALUES_GET_INTG
MODULE PROCEDURE VECTOR_VALUES_GET_INTG1
MODULE PROCEDURE VECTOR_VALUES_GET_SP
MODULE PROCEDURE VECTOR_VALUES_GET_SP1
MODULE PROCEDURE VECTOR_VALUES_GET_DP
MODULE PROCEDURE VECTOR_VALUES_GET_DP1
MODULE PROCEDURE VECTOR_VALUES_GET_L
MODULE PROCEDURE VECTOR_VALUES_GET_L1
END INTERFACE Vector_ValuesGet
INTERFACE VECTOR_VALUES_SET
MODULE PROCEDURE VECTOR_VALUES_SET_INTG
MODULE PROCEDURE VECTOR_VALUES_SET_INTG1
MODULE PROCEDURE VECTOR_VALUES_SET_SP
MODULE PROCEDURE VECTOR_VALUES_SET_SP1
MODULE PROCEDURE VECTOR_VALUES_SET_DP
MODULE PROCEDURE VECTOR_VALUES_SET_DP1
MODULE PROCEDURE VECTOR_VALUES_SET_L
MODULE PROCEDURE VECTOR_VALUES_SET_L1
END INTERFACE VECTOR_VALUES_SET
INTERFACE Vector_ValuesSet
MODULE PROCEDURE VECTOR_VALUES_SET_INTG
MODULE PROCEDURE VECTOR_VALUES_SET_INTG1
MODULE PROCEDURE VECTOR_VALUES_SET_SP
MODULE PROCEDURE VECTOR_VALUES_SET_SP1
MODULE PROCEDURE VECTOR_VALUES_SET_DP
MODULE PROCEDURE VECTOR_VALUES_SET_DP1
MODULE PROCEDURE VECTOR_VALUES_SET_L
MODULE PROCEDURE VECTOR_VALUES_SET_L1
END INTERFACE Vector_ValuesSet
INTERFACE Matrix_LinklistGet
MODULE PROCEDURE MATRIX_LINKLIST_GET
END INTERFACE Matrix_LinklistGet
INTERFACE Matrix_LinklistSet
MODULE PROCEDURE MATRIX_LINKLIST_SET
END INTERFACE Matrix_LinklistSet
PUBLIC MATRIX_VECTOR_INTG_TYPE,MATRIX_VECTOR_SP_TYPE,MATRIX_VECTOR_DP_TYPE,MATRIX_VECTOR_L_TYPE, &
MATRIX_VECTOR_SPC_TYPE,MATRIX_VECTOR_DPC_TYPE
PUBLIC MATRIX_BLOCK_STORAGE_TYPE,MATRIX_DIAGONAL_STORAGE_TYPE,MATRIX_COLUMN_MAJOR_STORAGE_TYPE,MATRIX_ROW_MAJOR_STORAGE_TYPE, &
& MATRIX_COMPRESSED_ROW_STORAGE_TYPE,MATRIX_COMPRESSED_COLUMN_STORAGE_TYPE,MATRIX_ROW_COLUMN_STORAGE_TYPE
PUBLIC MATRIX_SYMMETRIC_TYPE,MATRIX_HERMITIAN_TYPE,MATRIX_SKEW_SYMMETRIC_TYPE,MATRIX_UNSYMMETRIC_TYPE
PUBLIC MATRIX_ALL_VALUES_SET
PUBLIC Matrix_AllValuesSet
PUBLIC MATRIX_CREATE_FINISH,MATRIX_CREATE_START
PUBLIC Matrix_CreateStart,Matrix_CreateFinish
PUBLIC MATRIX_DATA_GET
PUBLIC MATRIX_DATA_TYPE_SET
PUBLIC Matrix_DataTypeGet,Matrix_DataTypeSet
PUBLIC Matrix_Destroy
PUBLIC Matrix_Duplicate
PUBLIC MATRIX_MAX_COLUMNS_PER_ROW_GET
PUBLIC Matrix_MaxColumnsPerRowGet
PUBLIC MATRIX_NUMBER_NON_ZEROS_GET,MATRIX_NUMBER_NON_ZEROS_SET
PUBLIC Matrix_NumberOfNonZerosGet,Matrix_NumberOfNonZerosSet
PUBLIC MATRIX_MAX_SIZE_SET
PUBLIC Matrix_MaxSizeSet
PUBLIC Matrix_Output
PUBLIC MATRIX_SIZE_SET
PUBLIC Matrix_SizeSet
PUBLIC MATRIX_STORAGE_LOCATION_FIND
PUBLIC Matrix_StorageLocationFind
PUBLIC MATRIX_STORAGE_LOCATIONS_GET,MATRIX_STORAGE_LOCATIONS_SET
PUBLIC Matrix_StorageLocationsGet,Matrix_StorageLocationsSet
PUBLIC MATRIX_STORAGE_TYPE_GET,MATRIX_STORAGE_TYPE_SET
PUBLIC Matrix_StorageTypeGet,Matrix_StorageTypeSet
PUBLIC Matrix_SymmetryTypeGet,Matrix_SymmetryTypeSet
PUBLIC MATRIX_VALUES_ADD
PUBLIC Matrix_ValuesAdd
PUBLIC MATRIX_VALUES_GET,MATRIX_VALUES_SET
PUBLIC Matrix_ValuesGet,Matrix_ValuesSet
PUBLIC VECTOR_ALL_VALUES_SET
PUBLIC Vector_AllValuesSet
PUBLIC VECTOR_CREATE_FINISH,VECTOR_CREATE_START
PUBLIC Vector_CreateFinish,Vector_CreateStart
PUBLIC VECTOR_DATA_GET
PUBLIC Vector_DataGet
PUBLIC VECTOR_DATA_TYPE_SET
PUBLIC Vector_DataTypeGet,Vector_DataTypeSet
PUBLIC Vector_Destroy
PUBLIC Vector_Duplicate
PUBLIC VECTOR_SIZE_SET
PUBLIC Vector_SizeSet
PUBLIC VECTOR_VALUES_GET,VECTOR_VALUES_SET
PUBLIC Vector_ValuesGet,Vector_ValuesSet
PUBLIC MATRIX_LINKLIST_GET,MATRIX_LINKLIST_SET
PUBLIC Matrix_LinklistGet,Matrix_LinklistSet
CONTAINS
!
!================================================================================================================================
!
!>Sets all values in an integer matrix to the specified value.
SUBROUTINE MATRIX_ALL_VALUES_SET_INTG(MATRIX,VALUE,ERR,ERROR,*)
!Argument variables
TYPE(MATRIX_TYPE), POINTER :: MATRIX !<A pointer to the matrix
INTEGER(INTG), INTENT(IN) :: VALUE !<The value to set
INTEGER(INTG), INTENT(OUT) :: ERR !<The error code
TYPE(VARYING_STRING), INTENT(OUT) :: ERROR !<The error string
!Local variables
TYPE(VARYING_STRING) :: LOCAL_ERROR
ENTERS("MATRIX_ALL_VALUES_SET_INTG",ERR,ERROR,*999)
IF(ASSOCIATED(MATRIX)) THEN
IF(MATRIX%MATRIX_FINISHED) THEN
IF(MATRIX%DATA_TYPE==MATRIX_VECTOR_INTG_TYPE) THEN
MATRIX%DATA_INTG=VALUE
ELSE
LOCAL_ERROR="The data type of "//TRIM(NUMBER_TO_VSTRING(MATRIX%DATA_TYPE,"*",ERR,ERROR))// &
& " does not correspond to the integer data type of the given value."
CALL FlagError(LOCAL_ERROR,ERR,ERROR,*999)
ENDIF
ELSE
CALL FlagError("The matrix has not been finished.",ERR,ERROR,*999)
ENDIF
ELSE
CALL FlagError("Matrix is not associated.",ERR,ERROR,*999)
ENDIF
EXITS("MATRIX_ALL_VALUES_SET_INTG")
RETURN
999 ERRORSEXITS("MATRIX_ALL_VALUES_SET_INTG",ERR,ERROR)
RETURN 1
END SUBROUTINE MATRIX_ALL_VALUES_SET_INTG
!
!================================================================================================================================
!
!>Sets all values in a single precision matrix to the specified value.
SUBROUTINE MATRIX_ALL_VALUES_SET_SP(MATRIX,VALUE,ERR,ERROR,*)
!Argument variables
TYPE(MATRIX_TYPE), POINTER :: MATRIX !<A pointer to the matrix
REAL(SP), INTENT(IN) :: VALUE !<The value to set
INTEGER(INTG), INTENT(OUT) :: ERR !<The error code
TYPE(VARYING_STRING), INTENT(OUT) :: ERROR !<The error string
!Local variables
TYPE(VARYING_STRING) :: LOCAL_ERROR
ENTERS("MATRIX_ALL_VALUES_SET_SP",ERR,ERROR,*999)
IF(ASSOCIATED(MATRIX)) THEN
IF(MATRIX%MATRIX_FINISHED) THEN
IF(MATRIX%DATA_TYPE==MATRIX_VECTOR_SP_TYPE) THEN
MATRIX%DATA_SP=VALUE
ELSE
LOCAL_ERROR="The data type of "//TRIM(NUMBER_TO_VSTRING(MATRIX%DATA_TYPE,"*",ERR,ERROR))// &
& " does not correspond to the single precision data type of the given value."
CALL FlagError(LOCAL_ERROR,ERR,ERROR,*999)
ENDIF
ELSE
CALL FlagError("The matrix has not been finished.",ERR,ERROR,*999)
ENDIF
ELSE
CALL FlagError("Matrix is not associated.",ERR,ERROR,*999)
ENDIF
EXITS("MATRIX_ALL_VALUES_SET_SP")
RETURN
999 ERRORSEXITS("MATRIX_ALL_VALUES_SET_SP",ERR,ERROR)
RETURN 1
END SUBROUTINE MATRIX_ALL_VALUES_SET_SP
!
!================================================================================================================================
!
!>Sets all values in a double precision matrix to the specified value.
SUBROUTINE MATRIX_ALL_VALUES_SET_DP(MATRIX,VALUE,ERR,ERROR,*)
!Argument variables
TYPE(MATRIX_TYPE), POINTER :: MATRIX !<A pointer to the matrix
REAL(DP), INTENT(IN) :: VALUE !<The value to set
INTEGER(INTG), INTENT(OUT) :: ERR !<The error code
TYPE(VARYING_STRING), INTENT(OUT) :: ERROR !<The error string
!Local variables
TYPE(VARYING_STRING) :: LOCAL_ERROR
ENTERS("MATRIX_ALL_VALUES_SET_DP",ERR,ERROR,*999)
IF(ASSOCIATED(MATRIX)) THEN
IF(MATRIX%MATRIX_FINISHED) THEN
IF(MATRIX%DATA_TYPE==MATRIX_VECTOR_DP_TYPE) THEN
MATRIX%DATA_DP=VALUE
ELSE
LOCAL_ERROR="The data type of "//TRIM(NUMBER_TO_VSTRING(MATRIX%DATA_TYPE,"*",ERR,ERROR))// &
& " does not correspond to the double precision data type of the given value."
CALL FlagError(LOCAL_ERROR,ERR,ERROR,*999)
ENDIF
ELSE
CALL FlagError("The matrix has not been finished.",ERR,ERROR,*999)
ENDIF
ELSE
CALL FlagError("Matrix is not associated.",ERR,ERROR,*999)
ENDIF
EXITS("MATRIX_ALL_VALUES_SET_DP")
RETURN
999 ERRORSEXITS("MATRIX_ALL_VALUES_SET_DP",ERR,ERROR)
RETURN 1
END SUBROUTINE MATRIX_ALL_VALUES_SET_DP
!
!================================================================================================================================
!
!>Sets all values in a logical matrix to the specified value.
SUBROUTINE MATRIX_ALL_VALUES_SET_L(MATRIX,VALUE,ERR,ERROR,*)
!Argument variables
TYPE(MATRIX_TYPE), POINTER :: MATRIX !<A pointer to the matrix
LOGICAL, INTENT(IN) :: VALUE !<The value to set
INTEGER(INTG), INTENT(OUT) :: ERR !<The error code
TYPE(VARYING_STRING), INTENT(OUT) :: ERROR !<The error string
!Local variables
TYPE(VARYING_STRING) :: LOCAL_ERROR
ENTERS("MATRIX_ALL_VALUES_SET_L",ERR,ERROR,*999)
IF(ASSOCIATED(MATRIX)) THEN
IF(MATRIX%MATRIX_FINISHED) THEN
IF(MATRIX%DATA_TYPE==MATRIX_VECTOR_L_TYPE) THEN
MATRIX%DATA_L=VALUE
ELSE
LOCAL_ERROR="The data type of "//TRIM(NUMBER_TO_VSTRING(MATRIX%DATA_TYPE,"*",ERR,ERROR))// &
& " does not correspond to the logical data type of the given value."
CALL FlagError(LOCAL_ERROR,ERR,ERROR,*999)
ENDIF
ELSE
CALL FlagError("The matrix has not been finished.",ERR,ERROR,*999)
ENDIF
ELSE
CALL FlagError("Matrix is not associated.",ERR,ERROR,*999)
ENDIF
EXITS("MATRIX_ALL_VALUES_SET_L")
RETURN
999 ERRORSEXITS("MATRIX_ALL_VALUES_SET_L",ERR,ERROR)
RETURN 1
END SUBROUTINE MATRIX_ALL_VALUES_SET_L
!
!================================================================================================================================
!
!>Finishes the creation a matrix.
SUBROUTINE MATRIX_CREATE_FINISH(MATRIX,ERR,ERROR,*)
!Argument variables
TYPE(MATRIX_TYPE), POINTER :: MATRIX !<A pointer to the matrix to finish
INTEGER(INTG), INTENT(OUT) :: ERR !<The error code
TYPE(VARYING_STRING), INTENT(OUT) :: ERROR !<The error string
!Local Variables
INTEGER(INTG) :: column_idx,COUNT,row_idx,row_idx2
TYPE(VARYING_STRING) :: LOCAL_ERROR
ENTERS("MATRIX_CREATE_FINISH",ERR,ERROR,*999)
IF(ASSOCIATED(MATRIX)) THEN
IF(MATRIX%MATRIX_FINISHED) THEN
CALL FlagError("Matrix has been finished.",ERR,ERROR,*999)
ELSE
SELECT CASE(MATRIX%STORAGE_TYPE)
CASE(MATRIX_BLOCK_STORAGE_TYPE)
IF(MATRIX%MAX_M==-1) MATRIX%MAX_M=MATRIX%M
IF(MATRIX%MAX_N==-1) MATRIX%MAX_N=MATRIX%N
MATRIX%SIZE=MATRIX%M*MATRIX%N
MATRIX%NUMBER_NON_ZEROS=MATRIX%M*MATRIX%N
MATRIX%MAXIMUM_COLUMN_INDICES_PER_ROW=MATRIX%N
CASE(MATRIX_DIAGONAL_STORAGE_TYPE)
IF(MATRIX%MAX_M==-1) MATRIX%MAX_M=MATRIX%M
IF(MATRIX%MAX_N==-1) MATRIX%MAX_N=MATRIX%N
MATRIX%SIZE=MATRIX%M
MATRIX%NUMBER_NON_ZEROS=MATRIX%M
MATRIX%MAXIMUM_COLUMN_INDICES_PER_ROW=1
CASE(MATRIX_COLUMN_MAJOR_STORAGE_TYPE)
IF(MATRIX%MAX_M==-1) CALL FlagError("Maximum number of rows has not been set for this matrix.",ERR,ERROR,*999)
IF(MATRIX%MAX_N==-1) CALL FlagError("Maximum number of columns has not been set for this matrix.",ERR,ERROR,*999)
MATRIX%SIZE=MATRIX%MAX_M*MATRIX%N
MATRIX%NUMBER_NON_ZEROS=MATRIX%M*MATRIX%N
MATRIX%MAXIMUM_COLUMN_INDICES_PER_ROW=MATRIX%N
CASE(MATRIX_ROW_MAJOR_STORAGE_TYPE)
IF(MATRIX%MAX_M==-1) CALL FlagError("Maximum number of rows has not been set for this matrix.",ERR,ERROR,*999)
IF(MATRIX%MAX_N==-1) CALL FlagError("Maximum number of columns has not been set for this matrix.",ERR,ERROR,*999)
MATRIX%SIZE=MATRIX%M*MATRIX%MAX_N
MATRIX%NUMBER_NON_ZEROS=MATRIX%M*MATRIX%N
MATRIX%MAXIMUM_COLUMN_INDICES_PER_ROW=MATRIX%N
CASE(MATRIX_COMPRESSED_ROW_STORAGE_TYPE)
IF(MATRIX%NUMBER_NON_ZEROS==-1) CALL FlagError("Number of non-zeros has not been set for this matrix.",ERR,ERROR,*999)
IF(MATRIX%MAX_M==-1) MATRIX%MAX_M=MATRIX%M
IF(MATRIX%MAX_N==-1) MATRIX%MAX_N=MATRIX%N
MATRIX%SIZE=MATRIX%NUMBER_NON_ZEROS
IF(.NOT.ALLOCATED(MATRIX%COLUMN_INDICES)) &
& CALL FlagError("Matrix storage locations column indices have not been set.",ERR,ERROR,*999)
IF(.NOT.ALLOCATED(MATRIX%ROW_INDICES)) &
& CALL FlagError("Matrix storage locations row indices have not been set.",ERR,ERROR,*999)
MATRIX%MAXIMUM_COLUMN_INDICES_PER_ROW=0
DO row_idx=1,MATRIX%M
IF((MATRIX%ROW_INDICES(row_idx+1)-MATRIX%ROW_INDICES(row_idx))>MATRIX%MAXIMUM_COLUMN_INDICES_PER_ROW) &
& MATRIX%MAXIMUM_COLUMN_INDICES_PER_ROW=MATRIX%ROW_INDICES(row_idx+1)-MATRIX%ROW_INDICES(row_idx)
ENDDO !row_idx
CASE(MATRIX_COMPRESSED_COLUMN_STORAGE_TYPE)
IF(MATRIX%NUMBER_NON_ZEROS==-1) CALL FlagError("Number of non-zeros has not been set for this matrix.",ERR,ERROR,*999)
IF(MATRIX%MAX_M==-1) MATRIX%MAX_M=MATRIX%M
IF(MATRIX%MAX_N==-1) MATRIX%MAX_N=MATRIX%N
MATRIX%SIZE=MATRIX%NUMBER_NON_ZEROS
IF(.NOT.ALLOCATED(MATRIX%COLUMN_INDICES)) &
& CALL FlagError("Matrix storage locations column indices have not been set.",ERR,ERROR,*999)
IF(.NOT.ALLOCATED(MATRIX%ROW_INDICES)) &
& CALL FlagError("Matrix storage locations row indices have not been set.",ERR,ERROR,*999)
MATRIX%MAXIMUM_COLUMN_INDICES_PER_ROW=0
DO row_idx=1,MATRIX%M
COUNT=0
DO column_idx=1,MATRIX%N
DO row_idx2=MATRIX%COLUMN_INDICES(column_idx),MATRIX%COLUMN_INDICES(column_idx+1)-1
IF(MATRIX%ROW_INDICES(row_idx2)==row_idx) COUNT=COUNT+1
ENDDO !row_idx2
ENDDO !column_idx
IF(COUNT>MATRIX%MAXIMUM_COLUMN_INDICES_PER_ROW) MATRIX%MAXIMUM_COLUMN_INDICES_PER_ROW=COUNT
ENDDO !row_idx
CASE(MATRIX_ROW_COLUMN_STORAGE_TYPE)
IF(MATRIX%NUMBER_NON_ZEROS==-1) CALL FlagError("Number of non-zeros has not been set for this matrix.",ERR,ERROR,*999)
IF(MATRIX%MAX_M==-1) MATRIX%MAX_M=MATRIX%M
IF(MATRIX%MAX_N==-1) MATRIX%MAX_N=MATRIX%N
MATRIX%SIZE=MATRIX%NUMBER_NON_ZEROS
IF(.NOT.ALLOCATED(MATRIX%COLUMN_INDICES)) &
& CALL FlagError("Matrix storage locations column indices have not been set.",ERR,ERROR,*999)
IF(.NOT.ALLOCATED(MATRIX%ROW_INDICES)) &
& CALL FlagError("Matrix storage locations row indices have not been set.",ERR,ERROR,*999)
MATRIX%MAXIMUM_COLUMN_INDICES_PER_ROW=0
DO row_idx=1,MATRIX%M
COUNT=0
DO row_idx2=1,MATRIX%NUMBER_NON_ZEROS
IF(MATRIX%ROW_INDICES(row_idx2)==row_idx) COUNT=COUNT+1
ENDDO !row_idx2
IF(COUNT>MATRIX%MAXIMUM_COLUMN_INDICES_PER_ROW) MATRIX%MAXIMUM_COLUMN_INDICES_PER_ROW=COUNT
ENDDO !row_idx
CASE DEFAULT
LOCAL_ERROR="The matrix storage type of "//TRIM(NUMBER_TO_VSTRING(MATRIX%STORAGE_TYPE,"*",ERR,ERROR))//" is invalid."
CALL FlagError(LOCAL_ERROR,ERR,ERROR,*999)
END SELECT
IF(MATRIX%SIZE>0) THEN
SELECT CASE(MATRIX%DATA_TYPE)
CASE(MATRIX_VECTOR_INTG_TYPE)
ALLOCATE(MATRIX%DATA_INTG(MATRIX%SIZE),STAT=ERR)
IF(ERR/=0) CALL FlagError("Could not allocate matrix integer data.",ERR,ERROR,*999)
CASE(MATRIX_VECTOR_SP_TYPE)
ALLOCATE(MATRIX%DATA_SP(MATRIX%SIZE),STAT=ERR)
IF(ERR/=0) CALL FlagError("Could not allocate matrix single precision data.",ERR,ERROR,*999)
CASE(MATRIX_VECTOR_DP_TYPE)
ALLOCATE(MATRIX%DATA_DP(MATRIX%SIZE),STAT=ERR)
IF(ERR/=0) CALL FlagError("Could not allocate matrix double precision data.",ERR,ERROR,*999)
CASE(MATRIX_VECTOR_L_TYPE)
ALLOCATE(MATRIX%DATA_L(MATRIX%SIZE),STAT=ERR)
IF(ERR/=0) CALL FlagError("Could not allocate matrix logical data.",ERR,ERROR,*999)
CASE(MATRIX_VECTOR_SPC_TYPE)
CALL FlagError("Not implemented.",ERR,ERROR,*999)
CASE(MATRIX_VECTOR_DPC_TYPE)
CALL FlagError("Not implemented.",ERR,ERROR,*999)
CASE DEFAULT
LOCAL_ERROR="The matrix data type of "//TRIM(NUMBER_TO_VSTRING(MATRIX%DATA_TYPE,"*",ERR,ERROR))//" is invalid."
CALL FlagError(LOCAL_ERROR,ERR,ERROR,*999)
END SELECT
ENDIF
MATRIX%ID=MATRIX_VECTOR_ID
MATRIX_VECTOR_ID=MATRIX_VECTOR_ID+1
MATRIX%MATRIX_FINISHED=.TRUE.
ENDIF
ELSE
CALL FlagError("Matrix is not associated.",ERR,ERROR,*999)
ENDIF
EXITS("MATRIX_CREATE_FINISH")
RETURN
!!TODO: deallocate on error
999 ERRORSEXITS("MATRIX_CREATE_FINISH",ERR,ERROR)
RETURN 1
END SUBROUTINE MATRIX_CREATE_FINISH
!
!================================================================================================================================
!
!>Starts the creation a matrix.
SUBROUTINE MATRIX_CREATE_START(MATRIX,ERR,ERROR,*)
!Argument variables
TYPE(MATRIX_TYPE), POINTER :: MATRIX !<A pointer to the matrix
INTEGER(INTG), INTENT(OUT) :: ERR !<The error code
TYPE(VARYING_STRING), INTENT(OUT) :: ERROR !<The error string
!Local Variables
ENTERS("MATRIX_CREATE_START",ERR,ERROR,*999)
IF(ASSOCIATED(MATRIX)) THEN
CALL FlagError("Matrix is already associated.",ERR,ERROR,*998)
ELSE
ALLOCATE(MATRIX,STAT=ERR)
IF(ERR/=0) CALL FlagError("Could not allocate the matrix.",ERR,ERROR,*999)
CALL MATRIX_INITIALISE(MATRIX,ERR,ERROR,*999)
!Set the defaults
MATRIX%DATA_TYPE=MATRIX_VECTOR_DP_TYPE
MATRIX%STORAGE_TYPE=MATRIX_BLOCK_STORAGE_TYPE
ENDIF
EXITS("MATRIX_CREATE_START")
RETURN
999 IF(ASSOCIATED(MATRIX)) CALL MATRIX_FINALISE(MATRIX,ERR,ERROR,*998)
998 ERRORSEXITS("MATRIX_CREATE_START",ERR,ERROR)
RETURN 1
END SUBROUTINE MATRIX_CREATE_START
!
!================================================================================================================================
!
!>Returns a pointer to the data of an integer matrix. Note: the values can be used for read operations but a MATRIX_VALUES_SET call must be used to change any values. The pointer should not be deallocated.
SUBROUTINE MATRIX_DATA_GET_INTG(MATRIX,DATA,ERR,ERROR,*)
!Argument variables
TYPE(MATRIX_TYPE), POINTER :: MATRIX !<A pointer to the matrix
INTEGER(INTG), POINTER :: DATA(:) !<On return a pointer to the matrix data
INTEGER(INTG), INTENT(OUT) :: ERR !<The error code
TYPE(VARYING_STRING), INTENT(OUT) :: ERROR !<The error string
!Local Variables
TYPE(VARYING_STRING) :: LOCAL_ERROR
ENTERS("MATRIX_DATA_GET_INTG",ERR,ERROR,*999)
IF(ASSOCIATED(MATRIX)) THEN
IF(ASSOCIATED(DATA)) THEN
CALL FlagError("Data is already associated.",ERR,ERROR,*999)
ELSE
NULLIFY(DATA)
IF(MATRIX%MATRIX_FINISHED) THEN
IF(MATRIX%DATA_TYPE==MATRIX_VECTOR_INTG_TYPE) THEN
DATA=>MATRIX%DATA_INTG
ELSE
LOCAL_ERROR="The data type of "//TRIM(NUMBER_TO_VSTRING(MATRIX%DATA_TYPE,"*",ERR,ERROR))// &
& " does not correspond to the integer data type of the requested values."
CALL FlagError(LOCAL_ERROR,ERR,ERROR,*999)
ENDIF
ELSE
CALL FlagError("The matrix has not been finished.",ERR,ERROR,*999)
ENDIF
ENDIF
ELSE
CALL FlagError("Matrix is not associated.",ERR,ERROR,*999)
ENDIF
EXITS("MATRIX_DATA_GET_INTG")
RETURN
999 ERRORSEXITS("MATRIX_DATA_GET_INTG",ERR,ERROR)
RETURN 1
END SUBROUTINE MATRIX_DATA_GET_INTG
!
!================================================================================================================================
!
!>Returns a pointer to the data of a single precision matrix. Note: the values can be used for read operations but aMATRIX_VALUES_SET call must be used to change any values. The pointer should not be deallocated.
SUBROUTINE MATRIX_DATA_GET_SP(MATRIX,DATA,ERR,ERROR,*)
!Argument variables
TYPE(MATRIX_TYPE), POINTER :: MATRIX !<A pointer to the matrix
REAL(SP), POINTER :: DATA(:) !<On return a pointer to the matrix data
INTEGER(INTG), INTENT(OUT) :: ERR !<The error code
TYPE(VARYING_STRING), INTENT(OUT) :: ERROR !<The error string
!Local Variables
TYPE(VARYING_STRING) :: LOCAL_ERROR
ENTERS("MATRIX_DATA_GET_SP",ERR,ERROR,*999)
IF(ASSOCIATED(MATRIX)) THEN
IF(ASSOCIATED(DATA)) THEN
CALL FlagError("Data is already associated.",ERR,ERROR,*999)
ELSE
NULLIFY(DATA)
IF(MATRIX%MATRIX_FINISHED) THEN
IF(MATRIX%DATA_TYPE==MATRIX_VECTOR_SP_TYPE) THEN
DATA=>MATRIX%DATA_SP
ELSE
LOCAL_ERROR="The data type of "//TRIM(NUMBER_TO_VSTRING(MATRIX%DATA_TYPE,"*",ERR,ERROR))// &
& " does not correspond to the single precision data type of the requested values."
CALL FlagError(LOCAL_ERROR,ERR,ERROR,*999)
ENDIF
ELSE
CALL FlagError("The matrix has not been finished.",ERR,ERROR,*999)
ENDIF
ENDIF
ELSE
CALL FlagError("Matrix is not associated.",ERR,ERROR,*999)
ENDIF
EXITS("MATRIX_DATA_GET_SP")
RETURN
999 ERRORSEXITS("MATRIX_DATA_GET_SP",ERR,ERROR)
RETURN 1
END SUBROUTINE MATRIX_DATA_GET_SP
!
!================================================================================================================================
!
!>Returns a pointer to the data of a double precision matrix. Note: the values can be used for read operations but a MATRIX_VALUES_SET call must be used to change any values. The pointer should not be deallocated.
SUBROUTINE MATRIX_DATA_GET_DP(MATRIX,DATA,ERR,ERROR,*)
!Argument variables
TYPE(MATRIX_TYPE), POINTER :: MATRIX !<A pointer to the matrix
REAL(DP), POINTER :: DATA(:) !<On return a pointer to the matrix data
INTEGER(INTG), INTENT(OUT) :: ERR !<The error code
TYPE(VARYING_STRING), INTENT(OUT) :: ERROR !<The error string
!Local Variables
TYPE(VARYING_STRING) :: LOCAL_ERROR
ENTERS("MATRIX_DATA_GET_DP",ERR,ERROR,*999)
IF(ASSOCIATED(MATRIX)) THEN
IF(ASSOCIATED(DATA)) THEN
CALL FlagError("Data is already associated.",ERR,ERROR,*999)
ELSE
NULLIFY(DATA)
IF(MATRIX%MATRIX_FINISHED) THEN
IF(MATRIX%DATA_TYPE==MATRIX_VECTOR_DP_TYPE) THEN