.. numpyCore Python documentation master file

numpyCore Python Documentation
==============================

**numpyCore Python** is a high-performance C++ implementation of the NumPy API, providing
NDArray and related numerical computing functionality with NumPy-compatible interfaces.

.. note::
   This documentation is auto-generated from the numpyCore Python bindings using
   runtime introspection.

Quick Start
-----------

.. code-block:: python

   import numpycore as np

   # Create array from list
   arr = np.array([1, 2, 3, 4, 5])
   print(arr.shape)    # (5,)
   print(arr.dtype)    # int64

   # Create 2D array
   mat = np.array([[1, 2, 3], [4, 5, 6]])
   print(mat.shape)    # (2, 3)
   print(mat.sum())    # 21

   # Create zeros/ones arrays
   zeros = np.zeros((3, 3))
   ones = np.ones((2, 4))

   # Use linear algebra
   result = np.linalg.inv(mat @ mat.T)

Installation
------------

.. code-block:: python

   # Add build directory to path
   import sys
   sys.path.insert(0, 'D:/Projects/Cpp2/x64/Release')

   # Import module
   import numpycore as np

Contents
--------

.. toctree::
   :maxdepth: 2
   :caption: API Reference

   api/index

Indices and tables
==================

* :ref:`genindex`
* :ref:`search`