File: matrix_market.h

package info (click to toggle)
python-escript 5.0-3
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 87,772 kB
  • ctags: 49,550
  • sloc: python: 585,488; cpp: 133,173; ansic: 18,675; xml: 3,283; sh: 690; makefile: 215
file content (168 lines) | stat: -rw-r--r-- 4,613 bytes parent folder | download | duplicates (4)
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
/*
 *  Copyright 2008-2009 NVIDIA Corporation
 *
 *  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.
 */

/*! \file matrix_market.h
 *  \brief MatrixMarket file I/O
 */

#pragma once

#include <cusp/detail/config.h>

#include <string>

namespace cusp
{
namespace io
{

/*! \addtogroup input_output Input/Output
 *  \addtogroup matrix_market MatrixMarket
 *  \ingroup input_output
 *  \{
 */

/*! \p read_matrix_market_file : Read a MatrixMarket file
 *
 * \param mtx a matrix container (e.g. \p csr_matrix or \p coo_matrix)
 * \param filename file name of the MatrixMarket file
 * \tparam Matrix matrix container
 *
 * \note any contents of \p mtx will be overwritten
 *
 * \code
 * #include <cusp/io/matrix_market.h>
 * #include <cusp/coo_matrix.h>
 * 
 * int main(void)
 * {
 *     // read matrix stored in A.mtx into a coo_matrix
 *     cusp::coo_matrix<int, float, cusp::device_memory> A;
 *     cusp::io::read_matrix_market_file(A, "A.mtx");
 * 
 *     return 0;
 * }
 * \endcode
 *
 * \see \p write_matrix_market_file
 * \see \p write_matrix_market_stream
 */
template <typename Matrix>
void read_matrix_market_file(Matrix& mtx, const std::string& filename);

/*! \p read_matrix_market_stream : Read MatrixMarket data from a stream.
 *
 * \param mtx a matrix container (e.g. \p csr_matrix or \p coo_matrix)
 * \param intput stream from which to read the MatrixMarket contents
 * \tparam Matrix matrix container
 * \tparam Stream stream type
 *
 * \note any contents of \p mtx will be overwritten
 *
 * \code
 * #include <cusp/io/matrix_market.h>
 * #include <cusp/coo_matrix.h>
 * 
 * int main(void)
 * {
 *     // read matrix stored in A.mtx into a coo_matrix
 *     cusp::coo_matrix<int, float, cusp::device_memory> A;
 *     cusp::io::read_matrix_market_stream(A, std::cin);
 * 
 *     return 0;
 * }
 * \endcode
 *
 * \see \p write_matrix_market_file
 * \see \p write_matrix_market_stream
 */
template <typename Matrix, typename Stream>
void read_matrix_market_stream(Matrix& mtx, Stream& input);


/*! \p write_matrix_market_file : Write a MatrixMarket file
 *
 * \param mtx a matrix container (e.g. \p csr_matrix or \p coo_matrix)
 * \param filename file name of the MatrixMarket file
 * \tparam Matrix matrix container
 *
 * \note if the file already exists it will be overwritten
 *
 * \code
 * #include <cusp/io/matrix_market.h>
 * #include <cusp/array2d.h>
 * 
 * int main(void)
 * {
 *     // create a simple example
 *     cusp::array2d<float, cusp::host_memory> A(3,4);
 *     A(0,0) = 10;  A(0,1) =  0;  A(0,2) = 20;  A(0,3) =  0;
 *     A(1,0) =  0;  A(1,1) = 30;  A(1,2) =  0;  A(1,3) = 40;
 *     A(2,0) = 50;  A(2,1) = 60;  A(2,2) = 70;  A(2,3) = 80;
 * 
 *     // save A into MatrixMarket file
 *     cusp::io::write_matrix_market_file(A, "A.mtx");
 * 
 *     return 0;
 * }
 * \endcode
 *
 * \see \p read_matrix_market_file
 * \see \p read_matrix_market_stream
 */
template <typename Matrix>
void write_matrix_market_file(const Matrix& mtx, const std::string& filename);

/*! \p write_matrix_market_stream : Write MatrixMarket data to a stream.
 *
 * \param mtx a matrix container (e.g. \p csr_matrix or \p coo_matrix)
 * \param output stream to which the MatrixMarket contents will be written
 * \tparam Matrix matrix container
 * \tparam Stream stream type
 *
 * \code
 * #include <cusp/io/matrix_market.h>
 * #include <cusp/array2d.h>
 * 
 * int main(void)
 * {
 *     // create a simple example
 *     cusp::array2d<float, cusp::host_memory> A(3,4);
 *     A(0,0) = 10;  A(0,1) =  0;  A(0,2) = 20;  A(0,3) =  0;
 *     A(1,0) =  0;  A(1,1) = 30;  A(1,2) =  0;  A(1,3) = 40;
 *     A(2,0) = 50;  A(2,1) = 60;  A(2,2) = 70;  A(2,3) = 80;
 * 
 *     // save A into MatrixMarket file
 *     cusp::io::write_matrix_market_stream(A, std::cout);
 * 
 *     return 0;
 * }
 * \endcode
 *
 * \see \p read_matrix_market_file
 * \see \p read_matrix_market_stream
 */
template <typename Matrix, typename Stream>
void write_matrix_market_stream(const Matrix& mtx, Stream& output);

/*! \}
 */

} //end namespace io
} //end namespace cusp

#include <cusp/io/detail/matrix_market.inl>