From 70e049f264d0c92e31c7fcbb6a8c39328ce45b09 Mon Sep 17 00:00:00 2001
From: Masterchef365 <duncan.freeman1@gmail.com>
Date: Fri, 28 Mar 2025 20:37:28 -0700
Subject: [PATCH] Mark fn's returning Result as must_use so that users handle
 the case that the 'out' variable is not mutated

---
 src/lib.rs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/lib.rs b/src/lib.rs
index 84ca12e..abe6ee2 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -274,6 +274,7 @@ pub fn add<T: Numeric<T>>(a: &Sprs<T>, b: &Sprs<T>, alpha: T, beta: T) -> Sprs<T
 ///
 /// See: `schol(...)`
 ///
+#[must_use]
 pub fn chol<T: Numeric<T>>(a: &Sprs<T>, s: &mut Symb) -> Result<Nmrc<T>, Error> {
     let mut top;
     let mut d;
@@ -372,6 +373,7 @@ pub fn chol<T: Numeric<T>>(a: &Sprs<T>, s: &mut Symb) -> Result<Nmrc<T>, Error>
 /// println!("{:?}", &b);
 /// ```
 ///
+#[must_use]
 pub fn cholsol<T: Numeric<T>>(a: &Sprs<T>, b: &mut [T], order: i8) -> Result<(), Error> {
     let n = a.n;
     let mut s = schol(a, order); // ordering and symbolic analysis
@@ -513,6 +515,7 @@ pub fn ltsolve<T: Numeric<T>>(l: &Sprs<T>, x: &mut [T]) {
 ///
 /// See: `sqr(...)`
 ///
+#[must_use]
 pub fn lu<T: Numeric<T>>(a: &Sprs<T>, s: &mut Symb, tol: T) -> Result<Nmrc<T>, Error> {
     let n = a.n;
     let mut col;
@@ -665,6 +668,7 @@ pub fn lu<T: Numeric<T>>(a: &Sprs<T>, s: &mut Symb, tol: T) -> Result<Nmrc<T>, E
 /// ```
 
 ///
+#[must_use]
 pub fn lusol<T: Numeric<T>>(a: &Sprs<T>, b: &mut [T], order: i8, tol: T) -> Result<(), Error> {
     let mut x = vec![T::zero(); a.n];
     let mut s;