Struct inkwell::types::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_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_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 fn const_float_from_string(self, slice: &str) -> FloatValue<'ctx>

Create a FloatValue from a string. LLVM provides no error handling here, so this may produce unexpected results and should not be relied upon for validation.

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

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

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

let f64_val = f64_type.const_float_from_string("3.");

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

let f64_val = f64_type.const_float_from_string("3");

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

let f64_val = f64_type.const_float_from_string("");

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

let f64_val = 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_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();
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(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);
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());

Trait Implementations§

source§

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

source§

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

Returns an AnyTypeEnum that represents the current type.
source§

fn print_to_string(&self) -> LLVMString

Prints the definition of a Type to a LLVMString.
source§

impl AsTypeRef for FloatType<'_>

source§

fn as_type_ref(&self) -> LLVMTypeRef

Returns the internal LLVM reference behind the type
source§

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

source§

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

Returns a BasicTypeEnum that represents the current type.
source§

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

Create a FunctionType with this BasicType as its return type. Read more
source§

fn is_sized(&self) -> bool

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

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

Gets the size of this BasicType. Value may vary depending on the target architecture. Read more
source§

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

Create an ArrayType with this BasicType as its elements. Read more
source§

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. Read more
source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for FloatType<'_>

source§

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

Formats the value using the given formatter. Read more
source§

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.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

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

§

type Error = ()

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

type Error = ()

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

type Error = ()

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

source§

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

source§

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

Auto Trait Implementations§

§

impl<'ctx> Freeze for FloatType<'ctx>

§

impl<'ctx> RefUnwindSafe for FloatType<'ctx>

§

impl<'ctx> !Send for FloatType<'ctx>

§

impl<'ctx> !Sync for FloatType<'ctx>

§

impl<'ctx> Unpin for FloatType<'ctx>

§

impl<'ctx> UnwindSafe for FloatType<'ctx>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.