Welcome to arraycontext’s documentation!

GPU arrays? Deferred-evaluation arrays? Just plain numpy arrays? You’d like your code to work with all of them? No problem! Comes with pre-made array context implementations for:

• numpy

• pyopencl

• jax.numpy

• pytato (for lazy/deferred evaluation)

• Debugging

• Profiling

arraycontext started life as an array abstraction for use with the meshmode unstrucuted discretization package.

Contents

• The Array Context Abstraction
  • Freezing and thawing
    • Usage guidelines
    • What does this mean concretely?
  • The interface of an array context
    • ArrayContext
      • ArrayContext.empty()
      • ArrayContext.zeros()
      • ArrayContext.empty_like()
      • ArrayContext.zeros_like()
      • ArrayContext.from_numpy()
      • ArrayContext.to_numpy()
      • ArrayContext.call_loopy()
      • ArrayContext.einsum()
      • ArrayContext.np
      • ArrayContext.array_types
      • ArrayContext.freeze()
      • ArrayContext.thaw()
      • ArrayContext.freeze_thaw()
      • ArrayContext.tag()
      • ArrayContext.tag_axis()
      • ArrayContext.compile()
    • tag_axes()
  • Types and Type Variables for Arrays and Containers
    • Array
      • Array.shape
      • Array.size
      • Array.dtype
    • ArrayT
    • ScalarLike
    • ArrayOrContainer
    • ArrayOrContainerT
    • ArrayOrContainerOrScalar
    • ArrayOrContainerOrScalarT
  • Internal typing helpers (do not import)
    • SelfType
  • Canonical locations for type annotations
    • ArrayT
    • ArrayOrContainerT
    • ArrayOrContainerOrScalarT
• Implementations of the Array Context Abstraction
  • Array context based on pyopencl.array
    • PyOpenCLArrayContext
      • PyOpenCLArrayContext.context
      • PyOpenCLArrayContext.queue
      • PyOpenCLArrayContext.allocator
      • PyOpenCLArrayContext.transform_loopy_program()
    • TaggableCLArray
      • TaggableCLArray.axes
      • TaggableCLArray.tags
    • Axis
    • to_tagged_cl_array()
  • Lazy/Deferred evaluation array context based on pytato
    • PytatoPyOpenCLArrayContext
      • PytatoPyOpenCLArrayContext.queue
      • PytatoPyOpenCLArrayContext.allocator
      • PytatoPyOpenCLArrayContext.__init__()
      • PytatoPyOpenCLArrayContext.transform_dag()
      • PytatoPyOpenCLArrayContext.compile()
    • PytatoJAXArrayContext
    • Compiling a Python callable (Internal)
      • BaseLazilyCompilingFunctionCaller
        • BaseLazilyCompilingFunctionCaller.f
        • BaseLazilyCompilingFunctionCaller.__call__()
      • LazilyPyOpenCLCompilingFunctionCaller
      • LazilyJAXCompilingFunctionCaller
      • CompiledFunction
        • CompiledFunction.pytato_program
        • CompiledFunction.input_id_to_name_in_program
        • CompiledFunction.__call__()
      • FromArrayContextCompile
  • Array context based on jax.numpy
    • EagerJAXArrayContext
  • numpy coverage
    • Array creation routines
    • Array manipulation routines
    • Linear algebra
    • Logic Functions
    • Mathematical functions
• Array Containers
  • ArrayContainer
  • ArrayContainerT
  • NotAnArrayContainerError
  • Serialization/deserialization
    • is_array_container_type()
    • serialize_container()
    • deserialize_container()
  • Context retrieval
    • get_container_context_opt()
    • get_container_context_recursively()
    • get_container_context_recursively_opt()
  • MultiVector support
    • register_multivector_as_array_container()
  • Canonical locations for type annotations
    • ArrayContainerT
    • ArrayOrContainerT
  • Containers with arithmetic
    • with_container_arithmetic()
  • Containers based on dataclasses
    • dataclass_array_container()
  • Traversing containers
    • map_array_container()
    • multimap_array_container()
    • rec_map_array_container()
    • rec_multimap_array_container()
    • map_reduce_array_container()
    • multimap_reduce_array_container()
    • rec_map_reduce_array_container()
    • rec_multimap_reduce_array_container()
    • Traversing decorators
      • mapped_over_array_containers()
      • multimapped_over_array_containers()
    • Freezing and thawing
      • freeze()
      • thaw()
    • Flattening and unflattening
      • flatten()
      • unflatten()
      • flat_size_and_dtype()
    • Numpy conversion
      • from_numpy()
      • to_numpy()
    • Algebraic operations
      • outer()
• Other functionality
  • Metadata (“tags”) for Arrays and Array Axes
    • NameHint
      • NameHint.name
  • ArrayContext-generating fixture for pytest
    • PytestArrayContextFactory
    • PytestPyOpenCLArrayContextFactory
      • PytestPyOpenCLArrayContextFactory.__init__()
      • PytestPyOpenCLArrayContextFactory.__call__()
    • pytest_generate_tests_for_array_contexts()
    • pytest_generate_tests_for_pyopencl_array_context()
  • Program creation for loopy
    • make_loopy_program()
• Installation
• User-visible Changes
  • Version 2021.1
• Licensing
• Acknowledgments
• 🚀 Github
• 💾 Download Releases

Indices and tables

• Index

• Module Index

• Search Page