From 1b886534915de32cabe747372d424d977d3c3aee Mon Sep 17 00:00:00 2001 From: lucascolley Date: Thu, 16 Jan 2025 20:08:53 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20data-api?= =?UTF-8?q?s/array-api-extra@84b540c0cd00d5bb3485d4175a7981c315989c58=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- _sources/index.md.txt | 11 ++++++++++- index.html | 11 +++++++++++ searchindex.js | 2 +- 3 files changed, 22 insertions(+), 2 deletions(-) diff --git a/_sources/index.md.txt b/_sources/index.md.txt index c1998cd..d15a624 100644 --- a/_sources/index.md.txt +++ b/_sources/index.md.txt @@ -112,7 +112,16 @@ See [an example of this in SciPy][scipy-vendor-example]. ``` [scipy-vendor-example]: -https://github.com/scipy/scipy/blob/main/scipy/_lib/_array_api_compat_vendor.py + https://github.com/scipy/scipy/blob/main/scipy/_lib/_array_api_compat_vendor.py + +## Versioning + +This project uses [EffVer](https://jacobtomlinson.dev/effver/). TL;DR: + +- To bump from version `x.y.z` to `x.(y+1).0` of array-api-extra, expect that + you may need to put in some work. +- To bump from version `x.y.z` to `x.y.(z+1)`, any work needed on your side + should be minimal. Please open an issue if this is not the case! (usage)= diff --git a/index.html b/index.html index 6ec46d6..1eb51c7 100644 --- a/index.html +++ b/index.html @@ -353,6 +353,16 @@

array-api-extraan example of this in SciPy.

+
+

Versioning

+

This project uses EffVer. TL;DR:

+
    +

  • To bump from version x.y.z to x.(y+1).0 of array-api-extra, expect that +you may need to put in some work.

    • +

  • To bump from version x.y.z to x.y.(z+1), any work needed on your side +should be minimal. Please open an issue if this is not the case!

    • +
+

Usage

Typical usage of this library looks like:

@@ -485,6 +495,7 @@

array-api-extraarray-api-extra diff --git a/searchindex.js b/searchindex.js index 4ca5d39..7c898a6 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"API Reference": [[0, null]], "Contributing": [[1, null]], "Contributors": [[2, null]], "Development workflow": [[1, "development-workflow"]], "How to contribute a function": [[1, "how-to-contribute-a-function"]], "Installation": [[13, "installation"]], "Scope": [[13, "scope"]], "Usage": [[13, "usage"]], "Vendoring": [[13, "vendoring"]], "array-api-extra": [[13, null]], "array_api_extra.at": [[3, null]], "array_api_extra.atleast_nd": [[4, null]], "array_api_extra.cov": [[5, null]], "array_api_extra.create_diagonal": [[6, null]], "array_api_extra.expand_dims": [[7, null]], "array_api_extra.kron": [[8, null]], "array_api_extra.nunique": [[9, null]], "array_api_extra.pad": [[10, null]], "array_api_extra.setdiff1d": [[11, null]], "array_api_extra.sinc": [[12, null]]}, "docnames": ["api-reference", "contributing", "contributors", "generated/array_api_extra.at", "generated/array_api_extra.atleast_nd", "generated/array_api_extra.cov", "generated/array_api_extra.create_diagonal", "generated/array_api_extra.expand_dims", "generated/array_api_extra.kron", "generated/array_api_extra.nunique", "generated/array_api_extra.pad", "generated/array_api_extra.setdiff1d", "generated/array_api_extra.sinc", "index"], "envversion": {"sphinx": 64, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1}, "filenames": ["api-reference.md", "contributing.md", "contributors.md", "generated/array_api_extra.at.rst", "generated/array_api_extra.atleast_nd.rst", "generated/array_api_extra.cov.rst", "generated/array_api_extra.create_diagonal.rst", "generated/array_api_extra.expand_dims.rst", "generated/array_api_extra.kron.rst", "generated/array_api_extra.nunique.rst", "generated/array_api_extra.pad.rst", "generated/array_api_extra.setdiff1d.rst", "generated/array_api_extra.sinc.rst", "index.md"], "indexentries": {"__init__() (array_api_extra.at method)": [[3, "array_api_extra.at.__init__", false]], "at (class in array_api_extra)": [[3, "array_api_extra.at", false]], "atleast_nd() (in module array_api_extra)": [[4, "array_api_extra.atleast_nd", false]], "cov() (in module array_api_extra)": [[5, "array_api_extra.cov", false]], "create_diagonal() (in module array_api_extra)": [[6, "array_api_extra.create_diagonal", false]], "expand_dims() (in module array_api_extra)": [[7, "array_api_extra.expand_dims", false]], "kron() (in module array_api_extra)": [[8, "array_api_extra.kron", false]], "nunique() (in module array_api_extra)": [[9, "array_api_extra.nunique", false]], "pad() (in module array_api_extra)": [[10, "array_api_extra.pad", false]], "setdiff1d() (in module array_api_extra)": [[11, "array_api_extra.setdiff1d", false]], "sinc() (in module array_api_extra)": [[12, "array_api_extra.sinc", false]]}, "objects": {"array_api_extra": [[3, 0, 1, "", "at"], [4, 2, 1, "", "atleast_nd"], [5, 2, 1, "", "cov"], [6, 2, 1, "", "create_diagonal"], [7, 2, 1, "", "expand_dims"], [8, 2, 1, "", "kron"], [9, 2, 1, "", "nunique"], [10, 2, 1, "", "pad"], [11, 2, 1, "", "setdiff1d"], [12, 2, 1, "", "sinc"]], "array_api_extra.at": [[3, 1, 1, "", "__init__"]]}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "method", "Python method"], "2": ["py", "function", "Python function"]}, "objtypes": {"0": "py:class", "1": "py:method", "2": "py:function"}, "terms": {"": [7, 13], "0": [3, 5, 6, 7, 8, 9, 10, 12], "00": 12, "00000000e": 12, "01": 12, "02": 12, "03943254e": 12, "04551152e": 12, "1": [3, 4, 5, 6, 7, 8, 11, 12], "10": 8, "100": 8, "11": 5, "12": 5, "123": 3, "124": 3, "125": 3, "14413333": 5, "16236208e": 12, "16434881e": 12, "17": 12, "1d": 11, "2": [3, 4, 5, 6, 7, 8, 11, 12, 13], "20": 8, "24": 8, "26137788e": 12, "286": 5, "3": [3, 4, 5, 8, 11, 12], "33872321e": 12, "35489284e": 12, "4": [4, 5, 6, 8, 11, 12], "40918587e": 12, "41": 12, "5": [8, 11, 12], "50": 8, "500": 8, "50444803e": 12, "55914881e": 12, "56826729e": 12, "6": [8, 11, 12], "60": 8, "600": 8, "68206631e": 12, "7": [8, 12], "70": 8, "700": 8, "71": 5, "8": [6, 12], "84680802e": 12, "89206682e": 12, "89817183e": 12, "9": 12, "90384387e": 12, "92362781e": 12, "A": [5, 6, 10, 12], "And": 13, "Be": 13, "For": [3, 12], "If": [1, 3, 4, 5, 7, 8, 10, 11, 13], "In": [3, 8, 13], "It": [9, 13], "On": 3, "The": [3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], "These": 13, "To": [1, 13], "__all__": 1, "__init__": [1, 3], "__setitem__": 3, "_array_api_compat_vendor": 13, "_array_namespace_orig": 13, "_func": 1, "aaron": 2, "abov": [3, 6], "accept": 13, "accident": 3, "across": 13, "ad": 13, "add": [1, 3, 13], "after": [3, 10], "after_0": 10, "after_n": 10, "against": 13, "agnost": [1, 13], "aim": 13, "algorithm": 13, "alias": 12, "all": [1, 2, 3, 5], "allow": 13, "alreadi": 13, "also": [7, 12, 13], "altern": [1, 3], "an": [1, 3, 4, 7, 9, 13], "ani": [1, 2, 3, 12, 13], "annot": [1, 13], "anti": [3, 12], "anymor": 3, "api": [1, 3], "appear": 7, "appli": 10, "applic": 12, "appropri": 13, "ar": [1, 3, 5, 7, 8, 11, 13], "arang": 8, "argument": [12, 13], "arrai": [1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12], "array_api_compat": 13, "array_api_extra": [1, 13], "array_api_strict": [4, 5, 6, 7, 8, 11, 12], "array_namespac": [3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], "asarrai": [3, 4, 5, 6, 7, 8, 11], "assum": [8, 11, 13], "assume_uniqu": 11, "athan": 2, "atleast_nd": 13, "avail": [1, 13], "avoid": 3, "ax": [4, 7], "axi": [5, 7, 10], "b": [3, 8], "back": 3, "backend": [3, 13], "backward": 13, "bandlimit": 12, "base": 13, "befor": 10, "before_0": 10, "before_n": 10, "behaviour": 3, "belong": 13, "below": [3, 6], "benefici": 3, "best": 3, "better": 13, "between": [3, 5], "block": 8, "bool": [3, 8, 11], "both": [3, 11], "bowhai": 2, "build": 1, "built": 13, "burovski": 2, "c": 8, "c_": 5, "calcul": [11, 12], "call": [3, 13], "can": [8, 9, 11, 13], "cannot": 3, "cardin": 12, "cardinali": 12, "carlo": 2, "carre\u00f1o": 2, "case": [8, 13], "caus": 3, "cd": 1, "chang": 3, "class": [1, 3], "clearli": [5, 13], "clone": [1, 13], "code": [1, 13], "collei": 2, "column": 5, "com": [1, 12], "combin": 5, "come": 13, "comfort": 1, "commit": 1, "common": [8, 12], "commonli": 12, "comparison": 11, "compat": [3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], "compliant": 3, "composit": 8, "comput": [8, 13], "conda": 13, "consid": 5, "constant": 10, "constant_valu": 10, "construct": [6, 12], "consum": [1, 13], "contain": [3, 5], "continu": 12, "contribut": 2, "contributor": 1, "convert": 1, "copi": [3, 10, 13], "correct": 3, "correl": 5, "correspond": 10, "could": [7, 13], "count": 9, "covari": 5, "cover": 3, "coverag": 1, "cp": 13, "creat": 13, "current": [10, 13], "d": [5, 6, 8], "dask": 9, "data": 1, "decreas": 5, "def": 13, "default": [3, 4, 5, 6, 7, 8, 9, 10, 11, 12], "definit": 12, "del": 3, "deleg": 13, "depend": [1, 3, 13], "dereferenc": 3, "determin": 13, "dev": [1, 13], "diagon": 6, "differ": [3, 11], "differenti": 12, "dimens": [4, 8], "dimension": [5, 9, 12], "direct": 5, "discret": 12, "displai": 1, "diverg": 3, "doc": [1, 13], "docstr": [1, 13], "doe": [3, 13], "domain": 13, "don": 3, "downstream": 13, "dtype": [3, 4, 5, 6, 7, 8, 11, 12], "e": [1, 3, 13], "each": [5, 10], "easi": 1, "echo": 13, "either": [3, 13], "element": [5, 8, 9, 10], "elementwis": 12, "els": 13, "emoji": 2, "en": 12, "end": 3, "enforc": 3, "ensur": [1, 3], "enter": 1, "environ": 1, "equal": [4, 10, 12], "equival": [3, 7, 8, 10], "eric": 12, "error": 7, "estim": 5, "etc": 3, "everywher": 12, "evgeni": 2, "examin": 5, "exampl": [3, 4, 5, 6, 7, 8, 11, 12, 13], "exist": [2, 13], "expand": [4, 7], "experienc": 1, "explicitli": [3, 8], "express": 3, "extend": 8, "extens": 13, "extra": 1, "ey": 8, "factor": 12, "fals": [3, 11], "fan": 2, "far": 1, "featur": 13, "feel": 1, "file": [1, 13], "filter": 12, "find": [11, 13], "first": 8, "float": 12, "float64": [5, 8, 12], "follow": [2, 7, 13], "forg": 13, "found": [1, 13], "free": 1, "from": [1, 3, 6, 8, 10, 12, 13], "function": [3, 5, 8, 12, 13], "fundament": 13, "further": 5, "g": [3, 13], "gener": [1, 13], "github": 1, "given": [3, 7, 13], "gommer": 2, "grisel": 2, "guarante": 13, "guidanc": 1, "guido": 2, "ha": [8, 12], "haberland": 2, "hammudoglu": 2, "have": [1, 3, 7, 12, 13], "head": 2, "helper": 13, "hook": [1, 13], "hous": 13, "how": 5, "howev": 1, "html": 12, "http": [1, 12], "i": [1, 3, 4, 5, 6, 7, 8, 10, 11, 12, 13], "i0": 8, "i1": 8, "iN": 8, "ideal": [3, 12], "idx": 3, "ii": 5, "ij": 5, "immedi": 3, "imperial": 2, "implement": [1, 3, 13], "import": [1, 3, 4, 5, 6, 7, 8, 11, 12, 13], "includ": [1, 12], "incompat": 13, "increas": [5, 13], "index": [3, 7], "indic": [3, 5, 13], "individu": 1, "infer": [3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], "infinit": 12, "input": [3, 4, 8, 9, 10, 11, 12, 13], "insert": 7, "insid": 13, "instal": 1, "instead": 13, "int": [4, 6, 7, 10], "int32": 3, "int64": [4, 5, 6, 7, 8, 11], "integ": [3, 9], "intend": 13, "interact": 1, "intern": 13, "interpol": 12, "ipython": 1, "irwin": 2, "isinst": 13, "issu": [1, 13], "its": [3, 7], "j": [2, 8], "j0": 8, "j1": 8, "jake": 2, "jakirkham": 2, "jax": [3, 9], "jn": 8, "jnp": 3, "joren": 2, "jt": 8, "k": 8, "k0": 8, "k1": 8, "kei": 2, "kernel": 12, "kind": [2, 13], "kn": 8, "know": [3, 13], "known": [3, 13], "kroneck": 8, "kt": 8, "kwarg": 13, "lanczo": 12, "later": 3, "latest": 13, "lazi": 9, "lead": 6, "least": 4, "let": 13, "level": [5, 13], "librari": [1, 3, 13], "like": [1, 13], "limit": 12, "linspac": 12, "lint": 1, "list": 10, "ll": 3, "local": 1, "look": 13, "luca": 2, "m": [5, 13], "made": [1, 8], "mai": [3, 7, 13], "make": [1, 12, 13], "mamba": 13, "mani": 10, "mark": 13, "mathemat": 12, "mathworld": 12, "matrix": 5, "matt": 2, "md": 1, "mean": 13, "method": 3, "meurer": 2, "mileag": 13, "minimum": 4, "mode": 10, "modifi": 3, "more": 12, "most": 12, "multi": 12, "multipl": [3, 5, 7], "must": [3, 12, 13], "myarrai": 13, "mylib": 13, "mypi": 1, "n": [5, 8], "name": 12, "namespac": [3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], "nativ": 13, "ndarrai": 3, "ndim": [4, 8, 10, 13], "ne": 12, "necessari": 8, "neg": [5, 6, 7], "never": 3, "new": [1, 4, 7, 13], "newaxi": 7, "next": 13, "none": [3, 4, 5, 6, 7, 8, 9, 10, 11, 12], "normal": [12, 13], "note": [3, 5, 7, 8, 12], "np": 3, "number": [4, 8, 9], "numpi": [3, 5, 7, 8], "numpydoc": [1, 13], "object": 3, "observ": 5, "obtain": 12, "occurr": 3, "offset": 6, "older": 13, "olivi": 2, "omar": 2, "omit": [3, 13], "ones": 8, "onli": [3, 10, 11, 12, 13], "open": [1, 13], "oper": 3, "opposit": 5, "option": [3, 4, 5, 6, 7, 8, 9, 10, 11, 12], "org": 12, "organ": 8, "origin": 3, "other": [3, 13], "otherwis": [9, 11, 13], "out": 13, "output": 3, "overrid": 13, "own": 13, "packag": 1, "pad_width": 10, "page": 13, "pair": 10, "pamphil": 2, "paramet": [3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], "part": 1, "particular": 13, "particularli": 3, "pass": [10, 13], "pattern": 3, "perfectli": 5, "perform": [3, 13], "pi": 12, "pin": 13, "pip": 13, "pixi": [1, 13], "place": [3, 7, 13], "pleas": 13, "point": 12, "posit": [6, 7, 13], "possibl": [3, 13], "possibli": 12, "pr": 1, "practic": 3, "pre": 1, "prepar": 13, "prepend": [4, 8], "present": 13, "preview": 1, "privat": 1, "problemat": 9, "process": [1, 12], "product": 8, "project": [2, 13], "prompt": 1, "proport": 12, "propos": 1, "provid": [5, 7, 13], "pure": 13, "py": [1, 13], "pylint": 1, "pypi": 13, "pyright": 1, "python": [1, 10, 13], "r0": 8, "r1": 8, "rais": 3, "ralf": 2, "ramo": 2, "re": 4, "read": 3, "real": 12, "realiti": 13, "reassign": 3, "recommend": 13, "recurs": 4, "refer": [1, 7, 12, 13], "releas": 13, "report": 1, "repositori": [1, 13], "repres": 5, "requir": 13, "resampl": 12, "reshap": 8, "resourc": 12, "result": [3, 4, 7, 11], "return": [3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], "reus": 3, "revers": 3, "risk": 3, "rn": 8, "roi": 2, "roughli": 7, "rout": 3, "row": 5, "run": 1, "s0": 8, "s1": 8, "salman": 2, "same": [3, 8, 12], "sampl": 5, "scalar": 10, "scale": 8, "scientif": 13, "scipi": 13, "second": 8, "see": 13, "separ": 1, "set": [3, 11, 13], "shape": [7, 8, 12], "shell": 1, "short": 12, "should": [3, 7, 13], "show": 5, "shown": 13, "side": 10, "signal": 12, "similar": 13, "sin": 12, "sinc_funct": 12, "sincfunct": 12, "sine": 12, "singl": [5, 10], "sinu": 12, "smallest": 8, "sn": 8, "snippet": 3, "so": [1, 13], "some": [1, 13], "soon": 3, "sort": 11, "spars": 3, "specif": [2, 13], "specifi": 7, "speed": 11, "src": [1, 13], "st": 8, "stabil": 13, "stack": 5, "standard": [1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], "state": 3, "str": 10, "strict": 13, "structur": 8, "style": [1, 13], "subset": [1, 5], "suit": 1, "sum": 13, "support": [3, 10, 13], "syntax": 3, "t": [3, 5, 8], "take": 12, "task": 1, "term": 13, "test": [1, 13], "test_func": 1, "thank": [1, 2], "thei": [3, 7, 13], "themselv": [1, 13], "thi": [2, 3, 5, 7, 10, 12, 13], "thoma": 2, "those": [3, 5], "tim": 2, "time": 12, "togeth": 5, "too": 13, "tool": 13, "top": [1, 13], "true": [3, 4, 8, 11], "tupl": [7, 8, 10], "twice": 3, "two": [3, 5, 8, 11], "type": [1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], "typic": 13, "u": 13, "undefin": 3, "uniqu": [7, 9, 11], "unnorm": 12, "until": 4, "up": [3, 11], "updat": 3, "us": [3, 6, 10, 12, 13], "user": 13, "uv": 13, "valu": [3, 10, 11, 12], "valueerror": 3, "vanderpla": 2, "vari": [3, 5, 13], "variabl": 5, "varianc": 5, "variou": [12, 13], "version": 13, "versu": 3, "via": 13, "visual": 8, "w": 12, "wai": 3, "want": 3, "we": [2, 3, 5, 13], "web": 12, "weisstein": 12, "welcom": [1, 2], "well": [3, 13], "when": [3, 11], "where": [7, 8, 13], "whether": 3, "which": [5, 10, 11, 12, 13], "while": 5, "who": 1, "whose": 9, "wiki": 12, "wikipedia": 12, "wish": 13, "without": 13, "wolfram": 12, "won": 3, "work": 13, "would": [1, 9], "write": [1, 3], "writeabl": 3, "written": 13, "x": [3, 4, 5, 6, 7, 9, 10, 12, 13], "x1": 11, "x2": 11, "x_0": 5, "x_1": 5, "x_2": 5, "x_i": 5, "x_j": 5, "x_n": 5, "xp": [3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], "xpx": [3, 4, 5, 6, 7, 8, 11, 12, 13], "y": [3, 5, 7, 13], "you": [1, 3, 13], "your": [1, 13], "z": 3, "zaid": 2, "zero": 10}, "titles": ["API Reference", "Contributing", "Contributors", "array_api_extra.at", "array_api_extra.atleast_nd", "array_api_extra.cov", "array_api_extra.create_diagonal", "array_api_extra.expand_dims", "array_api_extra.kron", "array_api_extra.nunique", "array_api_extra.pad", "array_api_extra.setdiff1d", "array_api_extra.sinc", "array-api-extra"], "titleterms": {"api": [0, 13], "arrai": 13, "array_api_extra": [3, 4, 5, 6, 7, 8, 9, 10, 11, 12], "atleast_nd": 4, "contribut": 1, "contributor": 2, "cov": 5, "create_diagon": 6, "develop": 1, "expand_dim": 7, "extra": 13, "function": 1, "how": 1, "instal": 13, "kron": 8, "nuniqu": 9, "pad": 10, "refer": 0, "scope": 13, "setdiff1d": 11, "sinc": 12, "usag": 13, "vendor": 13, "workflow": 1}}) \ No newline at end of file +Search.setIndex({"alltitles": {"API Reference": [[0, null]], "Contributing": [[1, null]], "Contributors": [[2, null]], "Development workflow": [[1, "development-workflow"]], "How to contribute a function": [[1, "how-to-contribute-a-function"]], "Installation": [[13, "installation"]], "Scope": [[13, "scope"]], "Usage": [[13, "usage"]], "Vendoring": [[13, "vendoring"]], "Versioning": [[13, "versioning"]], "array-api-extra": [[13, null]], "array_api_extra.at": [[3, null]], "array_api_extra.atleast_nd": [[4, null]], "array_api_extra.cov": [[5, null]], "array_api_extra.create_diagonal": [[6, null]], "array_api_extra.expand_dims": [[7, null]], "array_api_extra.kron": [[8, null]], "array_api_extra.nunique": [[9, null]], "array_api_extra.pad": [[10, null]], "array_api_extra.setdiff1d": [[11, null]], "array_api_extra.sinc": [[12, null]]}, "docnames": ["api-reference", "contributing", "contributors", "generated/array_api_extra.at", "generated/array_api_extra.atleast_nd", "generated/array_api_extra.cov", "generated/array_api_extra.create_diagonal", "generated/array_api_extra.expand_dims", "generated/array_api_extra.kron", "generated/array_api_extra.nunique", "generated/array_api_extra.pad", "generated/array_api_extra.setdiff1d", "generated/array_api_extra.sinc", "index"], "envversion": {"sphinx": 64, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1}, "filenames": ["api-reference.md", "contributing.md", "contributors.md", "generated/array_api_extra.at.rst", "generated/array_api_extra.atleast_nd.rst", "generated/array_api_extra.cov.rst", "generated/array_api_extra.create_diagonal.rst", "generated/array_api_extra.expand_dims.rst", "generated/array_api_extra.kron.rst", "generated/array_api_extra.nunique.rst", "generated/array_api_extra.pad.rst", "generated/array_api_extra.setdiff1d.rst", "generated/array_api_extra.sinc.rst", "index.md"], "indexentries": {"__init__() (array_api_extra.at method)": [[3, "array_api_extra.at.__init__", false]], "at (class in array_api_extra)": [[3, "array_api_extra.at", false]], "atleast_nd() (in module array_api_extra)": [[4, "array_api_extra.atleast_nd", false]], "cov() (in module array_api_extra)": [[5, "array_api_extra.cov", false]], "create_diagonal() (in module array_api_extra)": [[6, "array_api_extra.create_diagonal", false]], "expand_dims() (in module array_api_extra)": [[7, "array_api_extra.expand_dims", false]], "kron() (in module array_api_extra)": [[8, "array_api_extra.kron", false]], "nunique() (in module array_api_extra)": [[9, "array_api_extra.nunique", false]], "pad() (in module array_api_extra)": [[10, "array_api_extra.pad", false]], "setdiff1d() (in module array_api_extra)": [[11, "array_api_extra.setdiff1d", false]], "sinc() (in module array_api_extra)": [[12, "array_api_extra.sinc", false]]}, "objects": {"array_api_extra": [[3, 0, 1, "", "at"], [4, 2, 1, "", "atleast_nd"], [5, 2, 1, "", "cov"], [6, 2, 1, "", "create_diagonal"], [7, 2, 1, "", "expand_dims"], [8, 2, 1, "", "kron"], [9, 2, 1, "", "nunique"], [10, 2, 1, "", "pad"], [11, 2, 1, "", "setdiff1d"], [12, 2, 1, "", "sinc"]], "array_api_extra.at": [[3, 1, 1, "", "__init__"]]}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "method", "Python method"], "2": ["py", "function", "Python function"]}, "objtypes": {"0": "py:class", "1": "py:method", "2": "py:function"}, "terms": {"": [7, 13], "0": [3, 5, 6, 7, 8, 9, 10, 12, 13], "00": 12, "00000000e": 12, "01": 12, "02": 12, "03943254e": 12, "04551152e": 12, "1": [3, 4, 5, 6, 7, 8, 11, 12, 13], "10": 8, "100": 8, "11": 5, "12": 5, "123": 3, "124": 3, "125": 3, "14413333": 5, "16236208e": 12, "16434881e": 12, "17": 12, "1d": 11, "2": [3, 4, 5, 6, 7, 8, 11, 12, 13], "20": 8, "24": 8, "26137788e": 12, "286": 5, "3": [3, 4, 5, 8, 11, 12], "33872321e": 12, "35489284e": 12, "4": [4, 5, 6, 8, 11, 12], "40918587e": 12, "41": 12, "5": [8, 11, 12], "50": 8, "500": 8, "50444803e": 12, "55914881e": 12, "56826729e": 12, "6": [8, 11, 12], "60": 8, "600": 8, "68206631e": 12, "7": [8, 12], "70": 8, "700": 8, "71": 5, "8": [6, 12], "84680802e": 12, "89206682e": 12, "89817183e": 12, "9": 12, "90384387e": 12, "92362781e": 12, "A": [5, 6, 10, 12], "And": 13, "Be": 13, "For": [3, 12], "If": [1, 3, 4, 5, 7, 8, 10, 11, 13], "In": [3, 8, 13], "It": [9, 13], "On": 3, "The": [3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], "These": 13, "To": [1, 13], "__all__": 1, "__init__": [1, 3], "__setitem__": 3, "_array_api_compat_vendor": 13, "_array_namespace_orig": 13, "_func": 1, "aaron": 2, "abov": [3, 6], "accept": 13, "accident": 3, "across": 13, "ad": 13, "add": [1, 3, 13], "after": [3, 10], "after_0": 10, "after_n": 10, "against": 13, "agnost": [1, 13], "aim": 13, "algorithm": 13, "alias": 12, "all": [1, 2, 3, 5], "allow": 13, "alreadi": 13, "also": [7, 12, 13], "altern": [1, 3], "an": [1, 3, 4, 7, 9, 13], "ani": [1, 2, 3, 12, 13], "annot": [1, 13], "anti": [3, 12], "anymor": 3, "api": [1, 3], "appear": 7, "appli": 10, "applic": 12, "appropri": 13, "ar": [1, 3, 5, 7, 8, 11, 13], "arang": 8, "argument": [12, 13], "arrai": [1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12], "array_api_compat": 13, "array_api_extra": [1, 13], "array_api_strict": [4, 5, 6, 7, 8, 11, 12], "array_namespac": [3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], "asarrai": [3, 4, 5, 6, 7, 8, 11], "assum": [8, 11, 13], "assume_uniqu": 11, "athan": 2, "atleast_nd": 13, "avail": [1, 13], "avoid": 3, "ax": [4, 7], "axi": [5, 7, 10], "b": [3, 8], "back": 3, "backend": [3, 13], "backward": 13, "bandlimit": 12, "base": 13, "befor": 10, "before_0": 10, "before_n": 10, "behaviour": 3, "belong": 13, "below": [3, 6], "benefici": 3, "best": 3, "better": 13, "between": [3, 5], "block": 8, "bool": [3, 8, 11], "both": [3, 11], "bowhai": 2, "build": 1, "built": 13, "bump": 13, "burovski": 2, "c": 8, "c_": 5, "calcul": [11, 12], "call": [3, 13], "can": [8, 9, 11, 13], "cannot": 3, "cardin": 12, "cardinali": 12, "carlo": 2, "carre\u00f1o": 2, "case": [8, 13], "caus": 3, "cd": 1, "chang": 3, "class": [1, 3], "clearli": [5, 13], "clone": [1, 13], "code": [1, 13], "collei": 2, "column": 5, "com": [1, 12], "combin": 5, "come": 13, "comfort": 1, "commit": 1, "common": [8, 12], "commonli": 12, "comparison": 11, "compat": [3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], "compliant": 3, "composit": 8, "comput": [8, 13], "conda": 13, "consid": 5, "constant": 10, "constant_valu": 10, "construct": [6, 12], "consum": [1, 13], "contain": [3, 5], "continu": 12, "contribut": 2, "contributor": 1, "convert": 1, "copi": [3, 10, 13], "correct": 3, "correl": 5, "correspond": 10, "could": [7, 13], "count": 9, "covari": 5, "cover": 3, "coverag": 1, "cp": 13, "creat": 13, "current": [10, 13], "d": [5, 6, 8], "dask": 9, "data": 1, "decreas": 5, "def": 13, "default": [3, 4, 5, 6, 7, 8, 9, 10, 11, 12], "definit": 12, "del": 3, "deleg": 13, "depend": [1, 3, 13], "dereferenc": 3, "determin": 13, "dev": [1, 13], "diagon": 6, "differ": [3, 11], "differenti": 12, "dimens": [4, 8], "dimension": [5, 9, 12], "direct": 5, "discret": 12, "displai": 1, "diverg": 3, "doc": [1, 13], "docstr": [1, 13], "doe": [3, 13], "domain": 13, "don": 3, "downstream": 13, "dr": 13, "dtype": [3, 4, 5, 6, 7, 8, 11, 12], "e": [1, 3, 13], "each": [5, 10], "easi": 1, "echo": 13, "effver": 13, "either": [3, 13], "element": [5, 8, 9, 10], "elementwis": 12, "els": 13, "emoji": 2, "en": 12, "end": 3, "enforc": 3, "ensur": [1, 3], "enter": 1, "environ": 1, "equal": [4, 10, 12], "equival": [3, 7, 8, 10], "eric": 12, "error": 7, "estim": 5, "etc": 3, "everywher": 12, "evgeni": 2, "examin": 5, "exampl": [3, 4, 5, 6, 7, 8, 11, 12, 13], "exist": [2, 13], "expand": [4, 7], "expect": 13, "experienc": 1, "explicitli": [3, 8], "express": 3, "extend": 8, "extens": 13, "extra": 1, "ey": 8, "factor": 12, "fals": [3, 11], "fan": 2, "far": 1, "featur": 13, "feel": 1, "file": [1, 13], "filter": 12, "find": [11, 13], "first": 8, "float": 12, "float64": [5, 8, 12], "follow": [2, 7, 13], "forg": 13, "found": [1, 13], "free": 1, "from": [1, 3, 6, 8, 10, 12, 13], "function": [3, 5, 8, 12, 13], "fundament": 13, "further": 5, "g": [3, 13], "gener": [1, 13], "github": 1, "given": [3, 7, 13], "gommer": 2, "grisel": 2, "guarante": 13, "guidanc": 1, "guido": 2, "ha": [8, 12], "haberland": 2, "hammudoglu": 2, "have": [1, 3, 7, 12, 13], "head": 2, "helper": 13, "hook": [1, 13], "hous": 13, "how": 5, "howev": 1, "html": 12, "http": [1, 12], "i": [1, 3, 4, 5, 6, 7, 8, 10, 11, 12, 13], "i0": 8, "i1": 8, "iN": 8, "ideal": [3, 12], "idx": 3, "ii": 5, "ij": 5, "immedi": 3, "imperial": 2, "implement": [1, 3, 13], "import": [1, 3, 4, 5, 6, 7, 8, 11, 12, 13], "includ": [1, 12], "incompat": 13, "increas": [5, 13], "index": [3, 7], "indic": [3, 5, 13], "individu": 1, "infer": [3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], "infinit": 12, "input": [3, 4, 8, 9, 10, 11, 12, 13], "insert": 7, "insid": 13, "instal": 1, "instead": 13, "int": [4, 6, 7, 10], "int32": 3, "int64": [4, 5, 6, 7, 8, 11], "integ": [3, 9], "intend": 13, "interact": 1, "intern": 13, "interpol": 12, "ipython": 1, "irwin": 2, "isinst": 13, "issu": [1, 13], "its": [3, 7], "j": [2, 8], "j0": 8, "j1": 8, "jake": 2, "jakirkham": 2, "jax": [3, 9], "jn": 8, "jnp": 3, "joren": 2, "jt": 8, "k": 8, "k0": 8, "k1": 8, "kei": 2, "kernel": 12, "kind": [2, 13], "kn": 8, "know": [3, 13], "known": [3, 13], "kroneck": 8, "kt": 8, "kwarg": 13, "lanczo": 12, "later": 3, "latest": 13, "lazi": 9, "lead": 6, "least": 4, "let": 13, "level": [5, 13], "librari": [1, 3, 13], "like": [1, 13], "limit": 12, "linspac": 12, "lint": 1, "list": 10, "ll": 3, "local": 1, "look": 13, "luca": 2, "m": [5, 13], "made": [1, 8], "mai": [3, 7, 13], "make": [1, 12, 13], "mamba": 13, "mani": 10, "mark": 13, "mathemat": 12, "mathworld": 12, "matrix": 5, "matt": 2, "md": 1, "mean": 13, "method": 3, "meurer": 2, "mileag": 13, "minim": 13, "minimum": 4, "mode": 10, "modifi": 3, "more": 12, "most": 12, "multi": 12, "multipl": [3, 5, 7], "must": [3, 12, 13], "myarrai": 13, "mylib": 13, "mypi": 1, "n": [5, 8], "name": 12, "namespac": [3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], "nativ": 13, "ndarrai": 3, "ndim": [4, 8, 10, 13], "ne": 12, "necessari": 8, "need": 13, "neg": [5, 6, 7], "never": 3, "new": [1, 4, 7, 13], "newaxi": 7, "next": 13, "none": [3, 4, 5, 6, 7, 8, 9, 10, 11, 12], "normal": [12, 13], "note": [3, 5, 7, 8, 12], "np": 3, "number": [4, 8, 9], "numpi": [3, 5, 7, 8], "numpydoc": [1, 13], "object": 3, "observ": 5, "obtain": 12, "occurr": 3, "offset": 6, "older": 13, "olivi": 2, "omar": 2, "omit": [3, 13], "ones": 8, "onli": [3, 10, 11, 12, 13], "open": [1, 13], "oper": 3, "opposit": 5, "option": [3, 4, 5, 6, 7, 8, 9, 10, 11, 12], "org": 12, "organ": 8, "origin": 3, "other": [3, 13], "otherwis": [9, 11, 13], "out": 13, "output": 3, "overrid": 13, "own": 13, "packag": 1, "pad_width": 10, "page": 13, "pair": 10, "pamphil": 2, "paramet": [3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], "part": 1, "particular": 13, "particularli": 3, "pass": [10, 13], "pattern": 3, "perfectli": 5, "perform": [3, 13], "pi": 12, "pin": 13, "pip": 13, "pixi": [1, 13], "place": [3, 7, 13], "pleas": 13, "point": 12, "posit": [6, 7, 13], "possibl": [3, 13], "possibli": 12, "pr": 1, "practic": 3, "pre": 1, "prepar": 13, "prepend": [4, 8], "present": 13, "preview": 1, "privat": 1, "problemat": 9, "process": [1, 12], "product": 8, "project": [2, 13], "prompt": 1, "proport": 12, "propos": 1, "provid": [5, 7, 13], "pure": 13, "put": 13, "py": [1, 13], "pylint": 1, "pypi": 13, "pyright": 1, "python": [1, 10, 13], "r0": 8, "r1": 8, "rais": 3, "ralf": 2, "ramo": 2, "re": 4, "read": 3, "real": 12, "realiti": 13, "reassign": 3, "recommend": 13, "recurs": 4, "refer": [1, 7, 12, 13], "releas": 13, "report": 1, "repositori": [1, 13], "repres": 5, "requir": 13, "resampl": 12, "reshap": 8, "resourc": 12, "result": [3, 4, 7, 11], "return": [3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], "reus": 3, "revers": 3, "risk": 3, "rn": 8, "roi": 2, "roughli": 7, "rout": 3, "row": 5, "run": 1, "s0": 8, "s1": 8, "salman": 2, "same": [3, 8, 12], "sampl": 5, "scalar": 10, "scale": 8, "scientif": 13, "scipi": 13, "second": 8, "see": 13, "separ": 1, "set": [3, 11, 13], "shape": [7, 8, 12], "shell": 1, "short": 12, "should": [3, 7, 13], "show": 5, "shown": 13, "side": [10, 13], "signal": 12, "similar": 13, "sin": 12, "sinc_funct": 12, "sincfunct": 12, "sine": 12, "singl": [5, 10], "sinu": 12, "smallest": 8, "sn": 8, "snippet": 3, "so": [1, 13], "some": [1, 13], "soon": 3, "sort": 11, "spars": 3, "specif": [2, 13], "specifi": 7, "speed": 11, "src": [1, 13], "st": 8, "stabil": 13, "stack": 5, "standard": [1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], "state": 3, "str": 10, "strict": 13, "structur": 8, "style": [1, 13], "subset": [1, 5], "suit": 1, "sum": 13, "support": [3, 10, 13], "syntax": 3, "t": [3, 5, 8], "take": 12, "task": 1, "term": 13, "test": [1, 13], "test_func": 1, "thank": [1, 2], "thei": [3, 7, 13], "themselv": [1, 13], "thi": [2, 3, 5, 7, 10, 12, 13], "thoma": 2, "those": [3, 5], "tim": 2, "time": 12, "tl": 13, "togeth": 5, "too": 13, "tool": 13, "top": [1, 13], "true": [3, 4, 8, 11], "tupl": [7, 8, 10], "twice": 3, "two": [3, 5, 8, 11], "type": [1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], "typic": 13, "u": 13, "undefin": 3, "uniqu": [7, 9, 11], "unnorm": 12, "until": 4, "up": [3, 11], "updat": 3, "us": [3, 6, 10, 12, 13], "user": 13, "uv": 13, "valu": [3, 10, 11, 12], "valueerror": 3, "vanderpla": 2, "vari": [3, 5, 13], "variabl": 5, "varianc": 5, "variou": [12, 13], "versu": 3, "via": 13, "visual": 8, "w": 12, "wai": 3, "want": 3, "we": [2, 3, 5, 13], "web": 12, "weisstein": 12, "welcom": [1, 2], "well": [3, 13], "when": [3, 11], "where": [7, 8, 13], "whether": 3, "which": [5, 10, 11, 12, 13], "while": 5, "who": 1, "whose": 9, "wiki": 12, "wikipedia": 12, "wish": 13, "without": 13, "wolfram": 12, "won": 3, "work": 13, "would": [1, 9], "write": [1, 3], "writeabl": 3, "written": 13, "x": [3, 4, 5, 6, 7, 9, 10, 12, 13], "x1": 11, "x2": 11, "x_0": 5, "x_1": 5, "x_2": 5, "x_i": 5, "x_j": 5, "x_n": 5, "xp": [3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], "xpx": [3, 4, 5, 6, 7, 8, 11, 12, 13], "y": [3, 5, 7, 13], "you": [1, 3, 13], "your": [1, 13], "z": [3, 13], "zaid": 2, "zero": 10}, "titles": ["API Reference", "Contributing", "Contributors", "array_api_extra.at", "array_api_extra.atleast_nd", "array_api_extra.cov", "array_api_extra.create_diagonal", "array_api_extra.expand_dims", "array_api_extra.kron", "array_api_extra.nunique", "array_api_extra.pad", "array_api_extra.setdiff1d", "array_api_extra.sinc", "array-api-extra"], "titleterms": {"api": [0, 13], "arrai": 13, "array_api_extra": [3, 4, 5, 6, 7, 8, 9, 10, 11, 12], "atleast_nd": 4, "contribut": 1, "contributor": 2, "cov": 5, "create_diagon": 6, "develop": 1, "expand_dim": 7, "extra": 13, "function": 1, "how": 1, "instal": 13, "kron": 8, "nuniqu": 9, "pad": 10, "refer": 0, "scope": 13, "setdiff1d": 11, "sinc": 12, "usag": 13, "vendor": 13, "version": 13, "workflow": 1}}) \ No newline at end of file