Welcome to SQUINT’s documentation!

User Guide

• Introduction
  • Overview
• Key Features
• Installation
• Building and Testing
  • Compiler Support
  • Build Instructions
  • CMake Configuration
  • BLAS Backends
  • Enabling CUDA Support
  • Serving Documentation
• Core Components
  • Dimension System
  • Quantity System
  • Tensor System
• Quantities and Units
  • Basic Usage
  • Predefined Units
  • Unit Literals
  • Unit Conversions
  • Arithmetic with Units
  • Creating Custom Units
  • Using Units with Tensors
  • Error Checking
  • Basic Operations
  • Trigonometric Functions
  • Hyperbolic Functions
  • Comparison
• Geometry Functions
  • Projection Functions
  • Transformation Functions
  • Combining Transformations
• Tensors
  • Tensor Representation and Order
  • Tensor Construction
  • Basic Operations
  • Views and Reshaping
  • Linear Algebra Operations
  • Vector Operations
  • Matrix Operations
  • Statistical Functions
  • Tensor Contraction
  • Einstein Summation (einsum)
  • Tensor Error Checking
• GPU Tensor Usage
  • Enabling GPU Support
  • Creating GPU Tensors
  • Transferring Back to Host
  • Supported Operations
  • Performance Considerations
  • Example: Matrix Multiplication on GPU
  • Best Practices
• Advanced Features
  • Error Checking
  • Unit Conversions
  • Constants
  • Tensor Views with Step Sizes
  • Row-Major vs Column-Major Construction
  • Column-Major Construction (Default)
  • Row-Major Construction
  • Iteration Order
  • Specifying Strides
  • Performance Considerations
  • Best Practices
• API Reference
• Performance Considerations
• TODO

API Reference

• core
  • error_checking
  • concepts
  • Specific Concepts
  • memory
  • layout
• geometry
  • projections
  • transformations
• quantity
  • quantity_math
  • quantity
  • unit
  • quantity_types
  • dimension_types
  • unit_types
  • dimension
  • quantity_ops
  • constants
• tensor
  • tensor_element_access
  • tensor_op_compatibility
  • tensor_shape_manipulation
  • tensor_math
  • tensor_io
  • blas_backend
  • blas_backend_none
  • flat_iterator
  • tensor_types
  • scalar_ops
  • tensor_accessors
  • tensor_iteration
  • subview_iterator
  • tensor_assignment
  • element_wise_ops
  • tensor_constructors
  • tensor_creation
  • tensor_ops
  • tensor_view_operations
  • tensor
• util
  • sequence_utils
  • math_utils