Struct FloatType

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

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

Implementations

impl<'ctx> FloatType<'ctx>

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

Create FloatType from LLVMTypeRef

Safety

Undefined behavior, if referenced type isn’t float type

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);

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);

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

Creates a ScalableVectorType 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);

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

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

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);

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.);

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");

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");

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();

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

Gets the alignment 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_alignment = f32_type.get_alignment();

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);

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(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_ptr_type.get_element_type().into_float_type(), f32_type);

pub fn print_to_string(self) -> LLVMString

Print the definition of a FloatType to LLVMString.

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());

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

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

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());

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

Creates a GenericValue for use with ExecutionEngines.

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());

Trait Implementations

impl<'ctx> AnyType<'ctx> for FloatType<'ctx>

fn as_any_type_enum(&self) -> AnyTypeEnum<'ctx>

Returns an AnyTypeEnum that represents the current type.

fn print_to_string(&self) -> LLVMString

Prints the definition of a Type to a LLVMString.

impl AsTypeRef for FloatType<'_>

fn as_type_ref(&self) -> LLVMTypeRef

Returns the internal LLVM reference behind the type

impl<'ctx> BasicType<'ctx> for FloatType<'ctx>

fn as_basic_type_enum(&self) -> BasicTypeEnum<'ctx>

Returns a BasicTypeEnum that represents the current type.

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

Create a FunctionType with this BasicType as its return type.

fn is_sized(&self) -> bool

Determines whether or not this BasicType is sized or not. For example, opaque structs are unsized.

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

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

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

Create an ArrayType with this BasicType as its elements.

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.

Create a PointerType that points to this BasicType.

impl<'ctx> Clone for FloatType<'ctx>

fn clone(&self) -> FloatType<'ctx>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'ctx> Debug for FloatType<'ctx>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for FloatType<'_>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'ctx> FloatMathType<'ctx> for FloatType<'ctx>

type ValueType = FloatValue<'ctx>

The value instance of a float or float vector type.

type MathConvType = IntType<'ctx>

The type for float to int or float vector to int vector conversions.

impl<'ctx> From<FloatType<'ctx>> for AnyTypeEnum<'ctx>

fn from(value: FloatType<'_>) -> AnyTypeEnum<'_>

Converts to this type from the input type.

impl<'ctx> From<FloatType<'ctx>> for BasicMetadataTypeEnum<'ctx>

fn from(value: FloatType<'_>) -> BasicMetadataTypeEnum<'_>

Converts to this type from the input type.

impl<'ctx> From<FloatType<'ctx>> for BasicTypeEnum<'ctx>

fn from(value: FloatType<'_>) -> BasicTypeEnum<'_>

Converts to this type from the input type.

impl<'ctx> PartialEq for FloatType<'ctx>

fn eq(&self, other: &FloatType<'ctx>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for FloatType<'ctx>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: AnyTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'ctx> TryFrom<BasicMetadataTypeEnum<'ctx>> for FloatType<'ctx>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: BasicMetadataTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'ctx> TryFrom<BasicTypeEnum<'ctx>> for FloatType<'ctx>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: BasicTypeEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'ctx> Copy for FloatType<'ctx>

impl<'ctx> Eq for FloatType<'ctx>

impl<'ctx> StructuralPartialEq for FloatType<'ctx>