Implement dynamic, heap allocated vector type, immutable and mutable vector slice types,. major API refactor

.gitignore

@@ -1,5 +1,6 @@
 /target/
 Cargo.lock
 **/*.rs.bk
+examples
 .DS_Store
 

Cargo.toml

@@ -6,7 +6,7 @@ license = "Apache-2.0"
 edition = "2021"
 keywords = ["vector", "math", "real", "imaginary", "complex"]
 repository = "https://github.com/chrissimpkins/vectora"
-description = "A vector computation library"
+description = "Fast, Flexible n-Dimensional Vector Math for Rust"
 readme = "README.md"
 
 exclude = [
@@ -34,3 +34,6 @@ harness = false
 [package.metadata.docs.rs]
 # Whether to pass `--all-features` to Cargo (default: false)
 all-features = true
+
+[profile.release]
+lto = true

README.md

@@ -1,6 +1,6 @@
 <img src="https://raw.githubusercontent.com/chrissimpkins/vectora/img/img/vectora.png" width="350">
 
-## A Rust library for vector computation
+## Fast, Flexible n-Dimensional Vector Math for Rust
 
 [![Crates.io](https://img.shields.io/crates/v/vectora)](https://crates.io/crates/vectora)
 [![docs.rs](https://img.shields.io/docsrs/vectora)](https://docs.rs/vectora)
@@ -15,7 +15,7 @@
 
 ## About
 
-Vectora is a library for n-dimensional vector computation with real and complex scalar types. The main library entry point is the [`Vector`](https://docs.rs/vectora/latest/vectora/types/vector/struct.Vector.html) struct.  Please see the [Gettting Started Guide](https://docs.rs/vectora/latest/vectora/#getting-started) for a detailed library API overview with examples.
+Vectora is a library for n-dimensional vector math with real and complex scalar types. The main library entry point is the [`Vector`](https://docs.rs/vectora/latest/vectora/types/vector/struct.Vector.html) struct.  Please see the [Gettting Started Guide](https://docs.rs/vectora/latest/vectora/#getting-started) for a detailed library API overview with examples.
 
 ## User documentation
 

src/errors.rs

@@ -1,11 +1,15 @@
 //! Error types.
 
-/// Errors that occur while working with [`crate::types::vector::Vector`]
+/// Errors that occur while working with vector types.
 #[derive(Debug)]
 pub enum VectorError {
-    /// Occurs when an operation that requires data in a [`crate::types::vector::Vector`] is
-    /// requested with an empty [`crate::types::vector::Vector`]
+    /// Occurs when an operation that requires data in a vector type is
+    /// requested with an empty vector type.
     EmptyVectorError(String),
+    /// Occurs when two vectors need to be the same length to complete an operation, and are not.
+    MismatchedLengthError(String),
+    /// Occurs when a value extends outside of a mandatory range.
+    OutOfRangeError(String),
     /// Occurs when there is invalid data during an attempt to convert
     /// from [`slice`] data.
     TryFromSliceError(String),
@@ -14,6 +18,8 @@ pub enum VectorError {
     TryFromVecError(String),
     /// ValueError occurs when an invalid value is used in an operation
     ValueError(String),
+    /// Errors with invalid zero vectors
+    ZeroVectorError(String),
 }
 
 impl std::fmt::Display for VectorError {
@@ -22,6 +28,12 @@ impl std::fmt::Display for VectorError {
             VectorError::EmptyVectorError(s) => {
                 write!(f, "VectorError::EmptyVectorError: {s}")
             }
+            VectorError::MismatchedLengthError(s) => {
+                write!(f, "VectorError::MismatchedLengthError: {s}")
+            }
+            VectorError::OutOfRangeError(s) => {
+                write!(f, "VectorError::OutOfRangeError: {s}")
+            }
             VectorError::TryFromVecError(s) => {
                 write!(f, "VectorError::TryFromVecError: {s}")
             }
@@ -31,6 +43,9 @@ impl std::fmt::Display for VectorError {
             VectorError::ValueError(s) => {
                 write!(f, "VectorError::ValueError: {s}")
             }
+            VectorError::ZeroVectorError(s) => {
+                write!(f, "VectorError::ZeroVectorError: {s}")
+            }
         }
     }
 }

src/lib.rs

@@ -893,6 +893,29 @@
 #![cfg_attr(docsrs, feature(doc_cfg))]
 
 pub mod errors;
+pub mod macros;
 pub mod types;
 
+pub use types::flexvector::FlexVector;
 pub use types::vector::Vector;
+
+/// The vectora prelude: import this module to bring all core traits, types, and macros into scope.
+///
+/// This prelude includes:
+/// - Core traits
+/// - Main types
+/// - Main macros
+pub mod prelude {
+    // Traits
+    pub use crate::types::traits::{
+        Transposable, VectorBase, VectorBaseMut, VectorHasOrientation, VectorOps, VectorOpsComplex,
+        VectorOpsComplexMut, VectorOpsFloat, VectorOpsFloatMut, VectorOpsMut,
+    };
+    // Types
+    pub use crate::types::flexvector::FlexVector;
+    pub use crate::types::orientation::{Column, Row, VectorOrientation};
+    pub use crate::types::vector::Vector;
+    pub use crate::types::vectorslice::{VectorSlice, VectorSliceMut};
+    // Macros
+    pub use crate::{fv, fv_from, fv_iter, try_fv_iter, try_vector, vector};
+}