Number of elements (property)

This page documents an OPTIMADE Property Definition. See https://schemas.optimade.org/ for more information.

ID: https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/nelements
Definition name: nelements

Property name: Number of elements
Description: Number of different elements in the structure as an integer.
Type: integer
Implementation requirements:
- Support: SHOULD be supported by all implementations, i.e., SHOULD NOT be null.

Requirements/Conventions:

Querying:

Examples:

Formats: [JSON] [MD]

JSON definition:

{
    "$id": "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/nelements",
    "$schema": "https://schemas.optimade.org/meta/v1.2/optimade/property_definition.json",
    "title": "Number of elements",
    "x-optimade-type": "integer",
    "x-optimade-definition": {
        "label": "nelements_optimade_structures",
        "kind": "property",
        "version": "1.2.0",
        "format": "1.2",
        "name": "nelements"
    },
    "type": [
        "integer",
        "null"
    ],
    "description": "Number of different elements in the structure as an integer.\n\n**Requirements/Conventions**:\n\n- MUST be equal to the lengths of the list properties elements and elements_ratios, if they are provided.\n\n**Querying**:\n\n- Queries on this property can equivalently be formulated using `elements LENGTH`.\n- A filter that matches structures that have exactly 4 elements: `nelements=4`.\n- A filter that matches structures that have between 2 and 7 elements: `nelements>=2 AND nelements<=7`.",
    "examples": [
        3
    ],
    "x-optimade-unit": "dimensionless",
    "x-optimade-requirements": {
        "support": "should",
        "sortable": false,
        "query-support": "all mandatory"
    }
}