User Guide

This guide is the manual for using PolyMath as a library: constructing objects, computing with them, and working with the masks, derivatives, and units they carry. It assumes fluency with Python and NumPy but no knowledge of the package internals.

• Introduction and Installation
  • Purpose
  • Overview
  • The Classes
  • Installation
  • Importing
  • A First Calculation
  • Global Settings
• Objects, Shapes, and Broadcasting
  • Constructing Objects
  • Shape Versus Item
  • Reading Values Back
  • Reshaping
  • Broadcasting
  • Converting Between Classes
  • Read-Only Objects
  • Custom Attributes
• Arithmetic and Math Functions
  • Operators
  • Scalar Functions
  • Vector Functions
  • Matrices and Rotations
  • Polynomials
  • Results as Python Numbers
• Masks
  • What a Mask Means
  • Where Masks Come From
  • Inspecting a Mask
  • Three-Valued Logic
  • Shrinking
• Derivatives
  • Attaching a Derivative
  • Propagation
  • Partial Derivatives and Denominators
  • Managing Derivatives
• Units
  • Values Are Always in Standard Units
  • Available Units
  • Units in Arithmetic
  • Changing the Unit
• Indexing and Iteration
  • Basic Indexing
  • Indexing with PolyMath Objects
  • Assigning by Index
  • Indexing NumPy Arrays
  • Iteration
• Pickling and Storage
  • How Values Are Compressed
  • Choosing the Precision
• Type Annotations
  • The Type Aliases
  • Using an Alias
  • Checking Your Code