srenblad/nalgebra
1
0
Fork 0
forked from M-Labs/nalgebra
Code Pull Requests Activity

Polish docs for save_* matrix market methods

Browse Source
This commit is contained in:
Andreas Longva 2022-05-09 09:59:09 +02:00
parent 9b32195558
commit 59421896ce
1 changed files with 25 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
nalgebra-sparse/src/io/matrix_market.rs
View File

@ -1430,9 +1430,9 @@ fn next_dense_coordinate(
} }
} }
/// Write a sparse matrix into Matrix Market format string. /// Save a sparse matrix as a Matrix Market format string.
/// ///
/// The exporter only writes matrix into `coordinate` and `general` format. /// The exporter only writes the matrix into `coordinate` and `general` format.
/// ///
/// ///
/// Examples /// Examples
@ -1453,9 +1453,13 @@ fn next_dense_coordinate(
/// let generated_matrixmarket_str = save_to_matrix_market_str(&matrix); /// let generated_matrixmarket_str = save_to_matrix_market_str(&matrix);
/// assert_eq!(expected_str,generated_matrixmarket_str); /// assert_eq!(expected_str,generated_matrixmarket_str);
/// ``` /// ```
pub fn save_to_matrix_market_str<T: MatrixMarketScalar, S: MatrixMarketExport<T>>( pub fn save_to_matrix_market_str<T, S>(
sparse_matrix: &S, sparse_matrix: &S,
) -> String { ) -> String
where
T: MatrixMarketScalar,
S: MatrixMarketExport<T>
{
let mut bytes = Vec::<u8>::new(); let mut bytes = Vec::<u8>::new();
// This will call impl<A: Allocator> Write for Vec<u8, A> // This will call impl<A: Allocator> Write for Vec<u8, A>
// The vector will grow as needed. // The vector will grow as needed.
@ -1488,14 +1492,15 @@ pub fn save_to_matrix_market_str<T: MatrixMarketScalar, S: MatrixMarketExport<T>
/// let matrix = load_coo_from_matrix_market_str::<i32>(&str).unwrap(); /// let matrix = load_coo_from_matrix_market_str::<i32>(&str).unwrap();
/// save_to_matrix_market_file(&matrix,"path/to/matrix.mtx").unwrap(); /// save_to_matrix_market_file(&matrix,"path/to/matrix.mtx").unwrap();
/// ``` /// ```
pub fn save_to_matrix_market_file< pub fn save_to_matrix_market_file<T, S, P>(
sparse_matrix: &S,
path: P,
) -> Result<(), std::io::Error>
where
T: MatrixMarketScalar, T: MatrixMarketScalar,
S: MatrixMarketExport<T>, S: MatrixMarketExport<T>,
P: AsRef<Path>, P: AsRef<Path>,
>( {
sparse_matrix: &S,
path: P,
) -> Result<(), std::io::Error> {
let file = File::create(path)?; let file = File::create(path)?;
let mut file = BufWriter::new(file); let mut file = BufWriter::new(file);
save_to_matrix_market(&mut file, sparse_matrix)?; save_to_matrix_market(&mut file, sparse_matrix)?;
@ -1506,11 +1511,19 @@ pub fn save_to_matrix_market_file<
Ok(()) Ok(())
} }
/// low level implementation of writing sparse matrix into any [std::io::Write] object /// Save a sparse matrix to an [std::io::Write] instance.
pub fn save_to_matrix_market<T: MatrixMarketScalar, S: MatrixMarketExport<T>, W: Write>( ///
/// This is the most general save functionality. See [save_to_matrix_market_file] and
/// [save_to_matrix_market_str] for higher-level functionality.
pub fn save_to_matrix_market<T, S, W>(
mut w: W, mut w: W,
sparse_matrix: &S, sparse_matrix: &S,
) -> Result<(), std::io::Error> { ) -> Result<(), std::io::Error>
where
T: MatrixMarketScalar,
S: MatrixMarketExport<T>,
W: Write
{
// write header // write header
writeln!( writeln!(
w, w,