LHF Blueprint Schema

Type: object

Provides a complete description of an Blueprint (interconnections and functions) of LatticeHashForests.

 No Additional Properties

root lhf_version
Type: string

Minimum compatible version of LHF.

root namespace
Type: string

The namespace to put the generated Blueprint in.

root scalar_definitions
Type: object

List of definitions of scalar values of the Blueprint (e.g, tuples, numbers, etc.). The keys act as identifiers for each definition.

Each additional property must conform to the following schema

root scalar_definitions ScalarDefinition
Type: object

Describes a scalar type used in the Blueprint. The key that refers to this description is used as the identifier for this description.

 No Additional Properties

root scalar_definitions additionalProperties name
Type: string

Actual C++ Identifier for this scalar (e.g. int, int*, double, structs ...)

root scalar_definitions additionalProperties less
Type: string

Less-than functor for this scalar.

root scalar_definitions additionalProperties equal
Type: string

Equality functor for this scalar.

root scalar_definitions additionalProperties hash
Type: string

Hash generation functor for this scalar.

root scalar_definitions additionalProperties print
Type: string

Print functor for this scalar. NAME MAY CHANGE IN THE FUTURE.

root entity_definitions
Type: object

List of definitions of entities (LHFs) that exist in the Blueprint. The keys act as identifiers for each definition.

Each additional property must conform to the following schema

root entity_definitions EntityDefinition
Type: object
No Additional Properties

root entity_definitions additionalProperties name
Type: string

C++ identifier for the resultant entity.

root entity_definitions additionalProperties var_name
Type: string

Variable/member identifier for the resultant entity.

root entity_definitions additionalProperties user_exposed
Type: boolean

Whether the entity is exposed externally for usage.

root entity_definitions additionalProperties operations
Type: array of object

Custom operation descriptions supported by this entity.

 No Additional Items

Each item of this array must be:

root entity_definitions additionalProperties operations operations items
Type: object

root entity_definitions additionalProperties operations operations items name
Type: string

C++ identifier for this operation

root entity_definitions additionalProperties operations operations items recursive
Type: boolean

Specifies whether operation propagates to any child entities. NAME MAY CHANGE.

root blueprint
Type: array

The list of blueprints of the data structures. Each member of the array is a new tree describing that strucutre.

 No Additional Items

Each item of this array must be:

root blueprint BlueprintNode
Type: object

Describes a data structure within the Blueprint. This is a heterogeneous node.

root blueprint blueprint items oneOf SetNode
Type: object

Describes a set-like data structure. Accepts a parameter for member data.

 No Additional Properties

root blueprint blueprint items oneOf item 0 type
Type: const

Discriminator field. Identifies this sub-block as a set node.

Specific value: "set"

root blueprint blueprint items oneOf item 0 value
Type: object

Describes a data structure within the Blueprint. This is a heterogeneous node.

Same definition as blueprint_items

root blueprint blueprint items oneOf item 0 use_as
Type: string

The entity this member node is to be used as.
root blueprint blueprint items oneOf MapNode
Type: object

Describes a map-like data structure. Accepts a scalar parameter for the key, and any parameter for member data.

 No Additional Properties

root blueprint blueprint items oneOf item 1 type
Type: const

Discriminator field. Identifies this sub-block as a map node.

Specific value: "map"

root blueprint blueprint items oneOf item 1 key
Type: string

The scalar type of the map's keys.

root blueprint blueprint items oneOf item 1 value
Type: object

Describes a data structure within the Blueprint. This is a heterogeneous node.

Same definition as blueprint_items

root blueprint blueprint items oneOf item 1 use_as
Type: string

The entity this member node is to be used as.
root blueprint blueprint items oneOf TupleNode
Type: object

Describes tuple-like data. Can accept any number of (ordered) parameters of different data types

 No Additional Properties

root blueprint blueprint items oneOf item 2 type
Type: const

Discriminator field. Identifies this sub-block as a tuple node.

Specific value: "tuple"

root blueprint blueprint items oneOf item 2 value
Type: array

List of definitions of the tuple's members.

 No Additional Items

Each item of this array must be:

root blueprint blueprint items oneOf item 2 value BlueprintNode
Type: object

Describes a data structure within the Blueprint. This is a heterogeneous node.

Same definition as blueprint_items

root blueprint blueprint items oneOf item 2 use_as
Type: string

The entity this member node is to be used as.
root blueprint blueprint items oneOf ScalarNode
Type: object

Describes a singular scalar element.

 No Additional Properties

root blueprint blueprint items oneOf item 3 type
Type: const

Discriminator field. Identifies this sub-block as a scalar node.

Specific value: "scalar"

root blueprint blueprint items oneOf item 3 value
Type: string

The corresponding scalar type.

root blueprint blueprint items oneOf item 3 var_name
Type: string

Member/variable identifier for this scalar.

root blueprint blueprint items oneOf item 3 use_as
Type: string

The entity this member node is to be used as.