Struct FloatType

Source

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

Expand description

A FloatType is the type of a floating point constant or variable.

Implementations§

Source §

impl<'ctx> FloatType<'ctx>

Source

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

Create FloatType from LLVMTypeRef

§Safety

Undefined behavior, if referenced type isn’t float type

Source

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

Creates a FunctionType with this FloatType for its return type.

§Example

use inkwell::context::Context;

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

Source

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

Creates an ArrayType with this FloatType for its element type.

§Example

use inkwell::context::Context;

let context = Context::create();
let f32_type = context.f32_type();
let f32_array_type = f32_type.array_type(3);

assert_eq!(f32_array_type.len(), 3);
assert_eq!(f32_array_type.get_element_type().into_float_type(), f32_type);

Source

pub fn vec_type(self, size: u32) -> VectorType<'ctx>

Creates a VectorType with this FloatType for its element type.

§Example

use inkwell::context::Context;

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

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

Source

pub fn scalable_vec_type(self, size: u32) -> ScalableVectorType<'ctx>

Creates a scalable VectorType with this FloatType for its element type.

§Example

use inkwell::context::Context;

let context = Context::create();
let f32_type = context.f32_type();
let f32_vector_type = f32_type.scalable_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_float(self, value: f64) -> FloatValue<'ctx>

Creates a FloatValue representing a constant value of this FloatType. It will be automatically assigned this FloatType’s Context.

§Example

use inkwell::context::Context;

// Local Context
let context = Context::create();
let f32_type = context.f32_type();
let f32_value = f32_type.const_float(42.);

Source

pub unsafe fn const_float_from_string(self, slice: &str) -> FloatValue<'ctx>

Create a FloatValue from a string. This function is marked unsafe because LLVM provides no error handling here, so this may produce undefined behavior if an invalid string is used.

§Example

use inkwell::context::Context;
use inkwell::values::AnyValue;

let context = Context::create();
let f64_type = context.f64_type();
let f64_val = unsafe { f64_type.const_float_from_string("3.6") };

assert_eq!(f64_val.print_to_string().to_string(), "double 3.600000e+00");

let f64_val = unsafe { f64_type.const_float_from_string("3.") };

assert_eq!(f64_val.print_to_string().to_string(), "double 3.000000e+00");

let f64_val = unsafe { f64_type.const_float_from_string("3") };

assert_eq!(f64_val.print_to_string().to_string(), "double 3.000000e+00");

let f64_val = unsafe { f64_type.const_float_from_string("3.asd") };

assert_eq!(f64_val.print_to_string().to_string(), "double 0x7FF0000000000000");

Source

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

Creates a constant zero value of this FloatType.

§Example

use inkwell::context::Context;
use inkwell::values::AnyValue;

let context = Context::create();
let f32_type = context.f32_type();
let f32_zero = f32_type.const_zero();

assert_eq!(f32_zero.print_to_string().to_string(), "float 0.000000e+00");

Source

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

Gets the size of this FloatType. 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_type_size = f32_type.size_of();

Source

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

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

§Example

use inkwell::context::Context;

let context = Context::create();
let f32_type = context.f32_type();

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

Source

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

👎Deprecated:

Starting from version 15.0, LLVM doesn’t differentiate between pointer types. Use Context::ptr_type instead.

Creates a PointerType with this FloatType for its element type.

§Example

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

let context = Context::create();
let f32_type = context.f32_type();
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());

#[cfg(feature = "typed-pointers")]
assert_eq!(f32_ptr_type.get_element_type().into_float_type(), f32_type);

Source

pub fn get_bit_width(self) -> u32

Gets the bit width of a FloatType.

§Example

use inkwell::context::Context;

let context = Context::create();
let f128_type = context.f128_type();

assert_eq!(f128_type.get_bit_width(), 128);

Source

pub fn print_to_string(self) -> LLVMString

Print the definition of a FloatType to LLVMString.

Source

pub fn get_undef(&self) -> FloatValue<'ctx>

Creates an undefined instance of a FloatType.

§Example

use inkwell::context::Context;

let context = Context::create();
let f32_type = context.f32_type();
let f32_undef = f32_type.get_undef();

assert!(f32_undef.is_undef());

Source

pub fn get_poison(&self) -> FloatValue<'ctx>

Creates a poison instance of a FloatType.

§Example

use inkwell::context::Context;
use inkwell::values::AnyValue;

let context = Context::create();
let f32_type = context.f32_type();
let f32_poison = f32_type.get_poison();

assert!(f32_poison.is_poison());

Source

pub fn create_generic_value(self, value: f64) -> GenericValue<'ctx>

Creates a GenericValue for use with ExecutionEngines.

Source

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

Creates a constant ArrayValue.

§Example

use inkwell::context::Context;

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_array = f32_type.const_array(&[f32_val, f32_val2]);

assert!(f32_array.is_const());