Struct inkwell::types::VectorType

source ·

pub struct VectorType<'ctx> { /* private fields */ }

Expand description

A VectorType is the type of a multiple value SIMD constant or variable.

Implementations§

source §

impl<'ctx> VectorType<'ctx>

source

pub unsafe fn new(vector_type: LLVMTypeRef) -> Self

Create VectorType from LLVMTypeRef

Safety

Undefined behavior, if referenced type isn’t vector type

source

pub fn size_of(self) -> Option<IntValue<'ctx>>

Gets the size of this VectorType. Value may vary depending on the target architecture.

Example

use inkwell::context::Context;

let context = Context::create();
let f32_type = context.f32_type();
let f32_vec_type = f32_type.vec_type(3);
let f32_vec_type_size = f32_vec_type.size_of();

source

pub fn get_alignment(self) -> IntValue<'ctx>

Gets the alignment of this VectorType. Value may vary depending on the target architecture.

Example

use inkwell::context::Context;

let context = Context::create();
let f32_type = context.f32_type();
let f32_vec_type = f32_type.vec_type(7);
let f32_type_alignment = f32_vec_type.get_alignment();

source

pub fn get_size(self) -> u32

Gets the size of this VectorType.

Example

use inkwell::context::Context;

let context = Context::create();
let f32_type = context.f32_type();
let f32_vector_type = f32_type.vec_type(3);

assert_eq!(f32_vector_type.get_size(), 3);
assert_eq!(f32_vector_type.get_element_type().into_float_type(), f32_type);

source

pub fn const_vector<V: BasicValue<'ctx>>(values: &[V]) -> VectorValue<'ctx>

Creates a constant VectorValue.

Example

use inkwell::context::Context;
use inkwell::types::VectorType;

let context = Context::create();
let f32_type = context.f32_type();
let f32_val = f32_type.const_float(0.);
let f32_val2 = f32_type.const_float(2.);
let f32_vec_val = VectorType::const_vector(&[f32_val, f32_val2]);

assert!(f32_vec_val.is_constant_vector());

source

pub fn const_zero(self) -> VectorValue<'ctx>

Creates a constant zero value of this VectorType.

Example

use inkwell::context::Context;

let context = Context::create();
let f32_type = context.f32_type();
let f32_vec_type = f32_type.vec_type(7);
let f32_vec_zero = f32_vec_type.const_zero();

source

pub fn print_to_string(self) -> LLVMString

Print the definition of a VectorType to LLVMString.

source

pub fn get_undef(self) -> VectorValue<'ctx>

Creates an undefined instance of a VectorType.

Example

use inkwell::context::Context;
use inkwell::AddressSpace;

let context = Context::create();
let f32_type = context.f32_type();
let f32_vec_type = f32_type.vec_type(3);
let f32_vec_undef = f32_vec_type.get_undef();

assert!(f32_vec_undef.is_undef());

source

pub fn get_poison(self) -> VectorValue<'ctx>

Available on crate features llvm12-0 or llvm13-0 or llvm14-0 or llvm15-0 or llvm16-0 only.

Creates a poison instance of a VectorType.

Example

use inkwell::context::Context;
use inkwell::AddressSpace;

let context = Context::create();
let f32_type = context.f32_type();
let f32_vec_type = f32_type.vec_type(3);
let f32_vec_poison = f32_vec_type.get_undef();

assert!(f32_vec_poison.is_undef());

source

pub fn get_element_type(self) -> BasicTypeEnum<'ctx>

Gets the element type of this VectorType.

Example

use inkwell::context::Context;

let context = Context::create();
let f32_type = context.f32_type();
let f32_vector_type = f32_type.vec_type(3);

assert_eq!(f32_vector_type.get_size(), 3);
assert_eq!(f32_vector_type.get_element_type().into_float_type(), f32_type);

source

pub fn ptr_type(self, address_space: AddressSpace) -> PointerType<'ctx>

Creates a PointerType with this VectorType for its element type.

Example

use inkwell::context::Context;
use inkwell::AddressSpace;

let context = Context::create();
let f32_type = context.f32_type();
let f32_vec_type = f32_type.vec_type(3);
let f32_vec_ptr_type = f32_vec_type.ptr_type(AddressSpace::default());

#[cfg(any(
    feature = "llvm4-0",
    feature = "llvm5-0",
    feature = "llvm6-0",
    feature = "llvm7-0",
    feature = "llvm8-0",
    feature = "llvm9-0",
    feature = "llvm10-0",
    feature = "llvm11-0",
    feature = "llvm12-0",
    feature = "llvm13-0",
    feature = "llvm14-0"
))]
assert_eq!(f32_vec_ptr_type.get_element_type().into_vector_type(), f32_vec_type);

source

pub fn fn_type( self, param_types: &[BasicMetadataTypeEnum<'ctx>], is_var_args: bool ) -> FunctionType<'ctx>

Creates a FunctionType with this VectorType for its return type.

Example

use inkwell::context::Context;

let context = Context::create();
let f32_type = context.f32_type();
let f32_vec_type = f32_type.vec_type(3);
let fn_type = f32_vec_type.fn_type(&[], false);

source

pub fn array_type(self, size: u32) -> ArrayType<'ctx>

Creates an ArrayType with this VectorType for its element type.

Example

use inkwell::context::Context;

let context = Context::create();
let f32_type = context.f32_type();
let f32_vec_type = f32_type.vec_type(3);
let f32_vec_array_type = f32_vec_type.array_type(3);

assert_eq!(f32_vec_array_type.len(), 3);
assert_eq!(f32_vec_array_type.get_element_type().into_vector_type(), f32_vec_type);

source

pub fn const_array(self, values: &[VectorValue<'ctx>]) -> ArrayValue<'ctx>

Creates a constant ArrayValue.

Example

use inkwell::context::Context;
use inkwell::types::VectorType;

let context = Context::create();
let f32_type = context.f32_type();
let f32_val = f32_type.const_float(0.);
let f32_val2 = f32_type.const_float(2.);
let f32_vec_type = f32_type.vec_type(2);
let f32_vec_val = VectorType::const_vector(&[f32_val, f32_val2]);
let f32_array = f32_vec_type.const_array(&[f32_vec_val, f32_vec_val]);

assert!(f32_array.is_const());

source

pub fn get_context(self) -> ContextRef<'ctx>

Gets a reference to the Context this VectorType was created in.

Example

use inkwell::context::Context;

let context = Context::create();
let f32_type = context.f32_type();
let f32_vec_type = f32_type.vec_type(7);

assert_eq!(f32_vec_type.get_context(), context);