Skip to content

Commit 14bfef9

Browse files
committed
start adding conversions specs
1 parent c74ad09 commit 14bfef9

File tree

1 file changed

+63
-1
lines changed

1 file changed

+63
-1
lines changed

doc/specs/stdlib_sparse.md

Lines changed: 63 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,4 +161,66 @@ $$y=\alpha*M*x+\beta*y$$
161161

162162
`alpha`, `intent(in)`, `optional` : Shall be a scalar value of the same type as `vec_x`. Default value `alpha=1`.
163163

164-
`beta`, `intent(in)`, `optional` : Shall be a scalar value of the same type as `vec_x`. Default value `beta=0`.
164+
`beta`, `intent(in)`, `optional` : Shall be a scalar value of the same type as `vec_x`. Default value `beta=0`.
165+
166+
## `sparse_conversion` - Sparse matrix to matrix conversions
167+
168+
### Status
169+
170+
Experimental
171+
172+
### Description
173+
174+
This module provides facility functions for converting between storage formats.
175+
176+
### Syntax
177+
178+
`call ` [[stdlib_sparse_conversion(module):dense2coo(interface)]] `(dense,coo)`
179+
180+
### Arguments
181+
182+
`dense`, `intent(in)`: Shall be a rank-2 array of `real` or `complex` type.
183+
184+
`coo`, `intent(inout)`: Shall be a `COO` type of `real` or `complex` type.
185+
186+
### Syntax
187+
188+
`call ` [[stdlib_sparse_conversion(module):coo2dense(interface)]] `(coo,dense)`
189+
190+
### Arguments
191+
192+
`coo`, `intent(in)`: Shall be a `COO` type of `real` or `complex` type.
193+
194+
`dense`, `intent(inout)`: Shall be a rank-2 array of `real` or `complex` type.
195+
196+
### Syntax
197+
198+
`call ` [[stdlib_sparse_conversion(module):coo2csr(interface)]] `(coo,csr)`
199+
200+
### Arguments
201+
202+
`coo`, `intent(in)`: Shall be a `COO` type of `real` or `complex` type.
203+
204+
`csr`, `intent(inout)`: Shall be a `CSR` type of `real` or `complex` type.
205+
206+
### Syntax
207+
208+
`call ` [[stdlib_sparse_conversion(module):csr2coo(interface)]] `(csr,coo)`
209+
210+
### Arguments
211+
212+
`csr`, `intent(in)`: Shall be a `CSR` type of `real` or `complex` type.
213+
214+
`coo`, `intent(inout)`: Shall be a `COO` type of `real` or `complex` type.
215+
216+
### Syntax
217+
218+
`call ` [[stdlib_sparse_conversion(module):csr2sellc(interface)]] `(csr,sellc[,chunk])`
219+
220+
### Arguments
221+
222+
`csr`, `intent(in)`: Shall be a `CSR` type of `real` or `complex` type.
223+
224+
`sellc`, `intent(inout)`: Shall be a `SELLC` type of `real` or `complex` type.
225+
226+
`chunk`, `intent(in)`, `optional`: chunk size for the Sliced ELLPACK format.

0 commit comments

Comments
 (0)