order.json

{
    "id": "order",
    "summary": "Get the order of array elements",
    "description": "Computes the ranked (sorted) element positions in the original list (i.e., a permutation), either in ascending or descending order. The process ``rearrange()`` allows sorting the data based on the computed permutation.\n\n**Remarks:**\n\n* The positions in the result are zero-based.\n* The ordering of ties is implementation-dependent.\n* Temporal strings can *not* be compared based on their string representation due to the time zone/time-offset representations.",
    "categories": [
        "arrays",
        "sorting"
    ],
    "parameters": [
        {
            "name": "data",
            "description": "An array to compute the order for.",
            "schema": {
                "type": "array",
                "items": {
                    "anyOf": [
                        {
                            "type": "number"
                        },
                        {
                            "type": "null"
                        },
                        {
                            "type": "string",
                            "format": "date-time",
                            "subtype": "date-time"
                        },
                        {
                            "type": "string",
                            "format": "date",
                            "subtype": "date"
                        }
                    ]
                }
            }
        },
        {
            "name": "asc",
            "description": "The default sort order is ascending, with smallest values first. To sort in reverse (descending) order, set this parameter to `false`.",
            "schema": {
                "type": "boolean"
            },
            "default": true,
            "optional": true
        },
        {
            "name": "nodata",
            "description": "Controls the handling of no-data values (`null`). By default, they are removed. If set to `true`, missing values in the data are put last; if set to `false`, they are put first.",
            "schema": {
                "type": [
                    "boolean",
                    "null"
                ]
            },
            "default": null,
            "optional": true
        }
    ],
    "returns": {
        "description": "The computed permutation.",
        "schema": {
            "type": "array",
            "items": {
                "type": "integer",
                "minimum": 0
            }
        }
    },
    "examples": [
        {
            "arguments": {
                "data": [
                    6,
                    -1,
                    2,
                    null,
                    7,
                    4,
                    null,
                    8,
                    3,
                    9,
                    9
                ]
            },
            "returns": [
                1,
                2,
                8,
                5,
                0,
                4,
                7,
                9,
                10
            ]
        },
        {
            "arguments": {
                "data": [
                    6,
                    -1,
                    2,
                    null,
                    7,
                    4,
                    null,
                    8,
                    3,
                    9,
                    9
                ],
                "nodata": true
            },
            "returns": [
                1,
                2,
                8,
                5,
                0,
                4,
                7,
                9,
                10,
                3,
                6
            ]
        },
        {
            "arguments": {
                "data": [
                    6,
                    -1,
                    2,
                    null,
                    7,
                    4,
                    null,
                    8,
                    3,
                    9,
                    9
                ],
                "asc": false,
                "nodata": true
            },
            "returns": [
                9,
                10,
                7,
                4,
                0,
                5,
                8,
                2,
                1,
                3,
                6
            ]
        },
        {
            "arguments": {
                "data": [
                    6,
                    -1,
                    2,
                    null,
                    7,
                    4,
                    null,
                    8,
                    3,
                    9,
                    9
                ],
                "asc": false,
                "nodata": false
            },
            "returns": [
                3,
                6,
                9,
                10,
                7,
                4,
                0,
                5,
                8,
                2,
                1
            ]
        }
    ],
    "links": [
        {
            "rel": "about",
            "href": "http://mathworld.wolfram.com/Permutation.html",
            "title": "Permutation explained by Wolfram MathWorld"
        }
    ]
}