document the user-facing api of faer-core

Cargo.toml

@@ -8,6 +8,7 @@ members = [
   "faer-evd",
 ]
 exclude = ["faer-bench"]
+resolver = "2"
 
 [workspace.dependencies]
 coe-rs = "0.1"

faer-cholesky/Cargo.toml

@@ -27,7 +27,7 @@ std = ["faer-core/std", "pulp/std"]
 nightly = ["faer-core/nightly", "pulp/nightly"]
 
 [dev-dependencies]
-criterion = "0.4"
+criterion = "0.5"
 rand = "0.8.5"
 nalgebra = "0.32.2"
 assert_approx_eq = "1.1.0"

faer-cholesky/src/ldlt_diagonal/update.rs

@@ -650,6 +650,10 @@
     assert!(w.nrows() == n);
     assert!(alpha.nrows() == k);
 
+    if n == 0 {
+        return;
+    }
+
     RankRUpdate {
         ld: cholesky_factors,
         w,
@@ -832,7 +836,7 @@
     let r = inserted_matrix.ncols();
 
     assert!(cholesky_factors_extended.ncols() == new_n);
-    assert!(r < new_n);
+    assert!(r <= new_n);
     let old_n = new_n - r;
 
     assert!(insertion_index <= old_n);

faer-cholesky/src/llt/update.rs

@@ -918,6 +918,10 @@ pub fn rank_r_update_clobber<E: ComplexField>(
     assert!(w.nrows() == n);
     assert!(alpha.nrows() == k);
 
+    if n == 0 {
+        return Ok(());
+    }
+
     RankRUpdate {
         l: cholesky_factor,
         w,

faer-core/Cargo.toml

@@ -31,7 +31,7 @@ std = ["gemm/std", "pulp/std"]
 nightly = ["gemm/nightly", "pulp/nightly"]
 
 [dev-dependencies]
-criterion = "0.4"
+criterion = "0.5"
 rand = "0.8.5"
 nalgebra = "0.32.2"
 assert_approx_eq = "1.1.0"

faer-core/src/inverse.rs

@@ -128,7 +128,7 @@ unsafe fn invert_unit_lower_triangular_impl<E: ComplexField>(
     solve::solve_unit_lower_triangular_in_place(src_br, dst_bl, parallelism);
 }
 
-/// Computes the \[conjugate\] inverse of the lower triangular matrix `src` (with implicit unit
+/// Computes the inverse of the lower triangular matrix `src` (with implicit unit
 /// diagonal) and stores the strictly lower triangular part of the result to `dst`.
 ///
 /// # Panics
@@ -147,7 +147,7 @@ pub fn invert_unit_lower_triangular<E: ComplexField>(
     unsafe { invert_unit_lower_triangular_impl(dst, src, parallelism) }
 }
 
-/// Computes the \[conjugate\] inverse of the lower triangular matrix `src` and stores the
+/// Computes the inverse of the lower triangular matrix `src` and stores the
 /// lower triangular part of the result to `dst`.
 ///
 /// # Panics
@@ -166,7 +166,7 @@ pub fn invert_lower_triangular<E: ComplexField>(
     unsafe { invert_lower_triangular_impl(dst, src, parallelism) }
 }
 
-/// Computes the \[conjugate\] inverse of the upper triangular matrix `src` (with implicit unit
+/// Computes the inverse of the upper triangular matrix `src` (with implicit unit
 /// diagonal) and stores the strictly upper triangular part of the result to `dst`.
 ///
 /// # Panics
@@ -185,7 +185,7 @@ pub fn invert_unit_upper_triangular<E: ComplexField>(
     )
 }
 
-/// Computes the \[conjugate\] inverse of the upper triangular matrix `src` and stores the
+/// Computes the inverse of the upper triangular matrix `src` and stores the
 /// upper triangular part of the result to `dst`.
 ///
 /// # Panics