{ "content": [ { "type": "text", "text": "# _operator (pydoc)\n\n**Summary:** operator - Operator interface.\n\n## Section Outline\n\n- **NAME** (2 lines)\n- **DESCRIPTION** (6 lines)\n- **FUNCTIONS** (1 lines) — 51 subsections\n - abs (2 lines)\n - add (2 lines)\n - and_ (2 lines)\n - concat (2 lines)\n - contains (2 lines)\n - countOf (2 lines)\n - delitem (2 lines)\n - eq (2 lines)\n - floordiv (2 lines)\n - ge (2 lines)\n - getitem (2 lines)\n - gt (2 lines)\n - iadd (2 lines)\n - iand (2 lines)\n - iconcat (2 lines)\n - ifloordiv (2 lines)\n - ilshift (2 lines)\n - imatmul (2 lines)\n - imod (2 lines)\n - imul (2 lines)\n - index (2 lines)\n - indexOf (2 lines)\n - inv (2 lines)\n - invert (2 lines)\n - ior (2 lines)\n - ipow (2 lines)\n - irshift (2 lines)\n - is_ (2 lines)\n - is_not (2 lines)\n - isub (2 lines)\n - itruediv (2 lines)\n - ixor (2 lines)\n - le (2 lines)\n - length_hint (8 lines)\n - lshift (2 lines)\n - lt (2 lines)\n - matmul (2 lines)\n - mod (2 lines)\n - mul (2 lines)\n - ne (2 lines)\n - neg (2 lines)\n - not_ (2 lines)\n - or_ (2 lines)\n - pos (2 lines)\n - pow (2 lines)\n - rshift (2 lines)\n - setitem (2 lines)\n - sub (2 lines)\n - truediv (2 lines)\n - truth (2 lines)\n - xor (2 lines)\n- **FILE** (3 lines)\n\n## Full Content\n\n### NAME\n\noperator - Operator interface.\n\n### DESCRIPTION\n\nThis module exports a set of functions implemented in C corresponding\nto the intrinsic operators of Python. For example, operator.add(x, y)\nis equivalent to the expression x+y. The function names are those\nused for special methods; variants without leading and trailing\n'' are also provided for convenience.\n\n### FUNCTIONS\n\n#### abs\n\nSame as abs(a).\n\n#### add\n\nSame as a + b.\n\n#### and_\n\nSame as a & b.\n\n#### concat\n\nSame as a + b, for a and b sequences.\n\n#### contains\n\nSame as b in a (note reversed operands).\n\n#### countOf\n\nReturn the number of items in a which are, or which equal, b.\n\n#### delitem\n\nSame as del a[b].\n\n#### eq\n\nSame as a == b.\n\n#### floordiv\n\nSame as a // b.\n\n#### ge\n\nSame as a >= b.\n\n#### getitem\n\nSame as a[b].\n\n#### gt\n\nSame as a > b.\n\n#### iadd\n\nSame as a += b.\n\n#### iand\n\nSame as a &= b.\n\n#### iconcat\n\nSame as a += b, for a and b sequences.\n\n#### ifloordiv\n\nSame as a //= b.\n\n#### ilshift\n\nSame as a <<= b.\n\n#### imatmul\n\nSame as a @= b.\n\n#### imod\n\nSame as a %= b.\n\n#### imul\n\nSame as a *= b.\n\n#### index\n\nSame as a.index()\n\n#### indexOf\n\nReturn the first index of b in a.\n\n#### inv\n\nSame as ~a.\n\n#### invert\n\nSame as ~a.\n\n#### ior\n\nSame as a |= b.\n\n#### ipow\n\nSame as a = b.\n\n#### irshift\n\nSame as a >>= b.\n\n#### is_\n\nSame as a is b.\n\n#### is_not\n\nSame as a is not b.\n\n#### isub\n\nSame as a -= b.\n\n#### itruediv\n\nSame as a /= b.\n\n#### ixor\n\nSame as a ^= b.\n\n#### le\n\nSame as a <= b.\n\n#### length_hint\n\nReturn an estimate of the number of items in obj.\n\nThis is useful for presizing containers when building from an iterable.\n\nIf the object supports len(), the result will be exact.\nOtherwise, it may over- or under-estimate by an arbitrary amount.\nThe result will be an integer >= 0.\n\n#### lshift\n\nSame as a << b.\n\n#### lt\n\nSame as a < b.\n\n#### matmul\n\nSame as a @ b.\n\n#### mod\n\nSame as a % b.\n\n#### mul\n\nSame as a * b.\n\n#### ne\n\nSame as a != b.\n\n#### neg\n\nSame as -a.\n\n#### not_\n\nSame as not a.\n\n#### or_\n\nSame as a | b.\n\n#### pos\n\nSame as +a.\n\n#### pow\n\nSame as a b.\n\n#### rshift\n\nSame as a >> b.\n\n#### setitem\n\nSame as a[b] = c.\n\n#### sub\n\nSame as a - b.\n\n#### truediv\n\nSame as a / b.\n\n#### truth\n\nReturn True if a is true, False otherwise.\n\n#### xor\n\nSame as a ^ b.\n\n### FILE\n\n(built-in)\n\n" } ], "structuredContent": { "command": "_operator", "section": "", "mode": "pydoc", "summary": "operator - Operator interface.", "synopsis": null, "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [], "examples": [], "see_also": [], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "DESCRIPTION", "lines": 6, "subsections": [] }, { "name": "FUNCTIONS", "lines": 1, "subsections": [ { "name": "abs", "lines": 2 }, { "name": "add", "lines": 2 }, { "name": "and_", "lines": 2 }, { "name": "concat", "lines": 2 }, { "name": "contains", "lines": 2 }, { "name": "countOf", "lines": 2 }, { "name": "delitem", "lines": 2 }, { "name": "eq", "lines": 2 }, { "name": "floordiv", "lines": 2 }, { "name": "ge", "lines": 2 }, { "name": "getitem", "lines": 2 }, { "name": "gt", "lines": 2 }, { "name": "iadd", "lines": 2 }, { "name": "iand", "lines": 2 }, { "name": "iconcat", "lines": 2 }, { "name": "ifloordiv", "lines": 2 }, { "name": "ilshift", "lines": 2 }, { "name": "imatmul", "lines": 2 }, { "name": "imod", "lines": 2 }, { "name": "imul", "lines": 2 }, { "name": "index", "lines": 2 }, { "name": "indexOf", "lines": 2 }, { "name": "inv", "lines": 2 }, { "name": "invert", "lines": 2 }, { "name": "ior", "lines": 2 }, { "name": "ipow", "lines": 2 }, { "name": "irshift", "lines": 2 }, { "name": "is_", "lines": 2 }, { "name": "is_not", "lines": 2 }, { "name": "isub", "lines": 2 }, { "name": "itruediv", "lines": 2 }, { "name": "ixor", "lines": 2 }, { "name": "le", "lines": 2 }, { "name": "length_hint", "lines": 8 }, { "name": "lshift", "lines": 2 }, { "name": "lt", "lines": 2 }, { "name": "matmul", "lines": 2 }, { "name": "mod", "lines": 2 }, { "name": "mul", "lines": 2 }, { "name": "ne", "lines": 2 }, { "name": "neg", "lines": 2 }, { "name": "not_", "lines": 2 }, { "name": "or_", "lines": 2 }, { "name": "pos", "lines": 2 }, { "name": "pow", "lines": 2 }, { "name": "rshift", "lines": 2 }, { "name": "setitem", "lines": 2 }, { "name": "sub", "lines": 2 }, { "name": "truediv", "lines": 2 }, { "name": "truth", "lines": 2 }, { "name": "xor", "lines": 2 } ] }, { "name": "FILE", "lines": 3, "subsections": [] } ] } }