Engee documentation

Core.Builtins

The page is in the process of being translated.

API for embedded functions

The following built-in function APIs are considered unstable, but they contain basic definitions of what defines the capabilities and behavior of the Julia program. They are usually accessed via a higher-level universal API.

Core.memoryrefnew(::GenericMemory)
Core.memoryrefnew(::GenericMemoryRef, index::Int, [boundscheck::Bool])

Returns GenericMemoryRef for GenericMemory'. See description `memoryref.

Compatibility: Julia 1.11

This feature requires a version of Julia not lower than 1.11.

 
Core..memoryrefoffset(::GenericMemoryRef)

Returns the offset index that was used to create the MemoryRef'. See description `memoryref.

Compatibility: Julia 1.11

This feature requires a version of Julia not lower than 1.11.

 
Core.memoryrefget(::GenericMemoryRef, ordering::Symbol, boundscheck::Bool)

Returns the value stored by the MemoryRef reference, issuing a BoundsError if the Memory object is empty. See the description of ref[]. The specified memory ordering must be compatible with the 'isatomic` parameter.

Compatibility: Julia 1.11

This feature requires a version of Julia at least 1.11.

 
Core.memoryrefset!(::GenericMemoryRef, value, ordering::Symbol, boundscheck::Bool)

Saves the value by reference MemoryRef, issuing a BoundsError if the Memory object is empty. See the description of ref[] = value'. The specified memory ordering must be compatible with the 'isatomic parameter.

Compatibility: Julia 1.11

This feature requires a version of Julia not lower than 1.11.

 
Core.memoryref_isassigned(::GenericMemoryRef, ordering::Symbol, boundscheck::Bool)

Determines whether the value is stored by the MemoryRef reference, returning false if the Memory object is empty. See description isassigned(::Base.RefValue), Core.memoryrefget. The specified memory ordering must be compatible with the 'isatomic` parameter.

Compatibility: Julia 1.11

This feature requires a version of Julia not lower than 1.11.

 
Core.memoryrefswap!(::GenericMemoryRef, value, ordering::Symbol, boundscheck::Bool)

Atomically performs operations for simultaneously obtaining and setting the MemoryRef value.

Compatibility: Julia 1.11

This feature requires a version of Julia at least 1.11.

See also the description swapproperty! and Core.memoryrefset!.

Core.memoryrefmodify!(::GenericMemoryRef, op, value, ordering::Symbol, boundscheck::Bool) -> Pair

Atomically performs operations to obtain and set the value of MemoryRef after applying the 'op` function.

Compatibility: Julia 1.11

This feature requires a version of Julia not lower than 1.11.

See also the description modifyproperty! and Core.memoryrefset!.

Core.memoryrefreplace!(::GenericMemoryRef, expected, desired,
                       success_order::Symbol, fail_order::Symbol=success_order, boundscheck::Bool) -> (; old, success::Bool)

Atomically performs operations to obtain the `MemoryRef' value and its conditional assignment.

Compatibility: Julia 1.11

This feature requires a version of Julia not lower than 1.11.

See also the description replaceproperty! and Core.memoryrefset!.

Core.memoryrefsetonce!(::GenericMemoryRef, value,
                       success_order::Symbol, fail_order::Symbol=success_order, boundscheck::Bool) -> success::Bool

Atomically performs the operations of assigning the specified value to MemoryRef, if it has not already been set.

Compatibility: Julia 1.11

This feature requires a version of Julia at least 1.11.

See also the description setpropertyonce! and Core.memoryrefset!.

Core.Intrinsics.atomic_pointerref(pointer::Ptr{T}, order::Symbol) --> T
Compatibility: Julia 1.7

This feature requires a version of Julia at least 1.7.

See the description unsafe_load.

Core.Intrinsics.atomic_pointerset(pointer::Ptr{T}, new::T, order::Symbol) --> pointer
Compatibility: Julia 1.7

This feature requires a version of Julia at least 1.7.

See the description unsafe_store!.

Core.Intrinsics.atomic_pointerswap(pointer::Ptr{T}, new::T, order::Symbol) --> old
Compatibility: Julia 1.7

This feature requires a version of Julia at least 1.7.

See the description unsafe_swap!.

Core.Intrinsics.atomic_pointermodify(pointer::Ptr{T}, function::(old::T,arg::S)->T, arg::S, order::Symbol) --> old
Compatibility: Julia 1.7

This feature requires a version of Julia at least 1.7.

See the description unsafe_modify!.

Core.Intrinsics.atomic_pointerreplace(pointer::Ptr{T}, expected::Any, new::T, success_order::Symbol, failure_order::Symbol) --> (old, cmp)
Compatibility: Julia 1.7

This feature requires a version of Julia at least 1.7.

See the description unsafe_replace!.

Core.get_binding_type(module::Module, name::Symbol)

Gets the declared binding type name from the module `module'.

Compatibility: Julia 1.9

This feature requires a Julia version of at least 1.9.

 
Core.set_binding_type!(module::Module, name::Symbol, [type::Type])

Sets the declared binding type name in the module as type'. If the binding already has a type that is not equivalent to `type', it returns an error. If the `type argument is missing, the binding type is set to Any if it is not already set, but no error is returned.

Compatibility: Julia 1.9

This feature requires a Julia version of at least 1.9.

 
Core.IntrinsicFunction <: Core.Builtin <: Function

The Core' function.IntrinsicFunction defines the basic primitives that define the capabilities and behavior of the Julia program.

Core.Intrinsics

The Core' module.Intrinsics contains Core' objects.IntrinsicFunction.

Core.IR

The module `Core.IR ` exports the IR object model.