Module club.doki7.ffm

Package club.doki7.ffm.ptr

Record Class FloatPtr

java.lang.Object

java.lang.Record

club.doki7.ffm.ptr.FloatPtr

All Implemented Interfaces:

IPointer, Iterable<Float>

@ValueBasedCandidate
@UnsafeConstructor
public record FloatPtr(@NotNull MemorySegment segment)
extends Record
implements IPointer, Iterable<Float>

Constructor Summary

Constructors

Constructor	Description
FloatPtr(@NotNull MemorySegment segment)	Creates an instance of a FloatPtr record class.

Method Summary

Modifier and Type	Method	Description
static @NotNull FloatPtr	allocate(@NotNull Arena arena)
static @NotNull FloatPtr	allocate(@NotNull Arena arena, float @NotNull [] array)
static @NotNull FloatPtr	allocate(@NotNull Arena arena, long size)
static @NotNull FloatPtr	allocate(@NotNull Arena arena, @NotNull FloatBuffer buffer)
static @NotNull FloatPtr	allocate(@NotNull Arena arena, Collection<Float> floats)
static @NotNull FloatPtr	allocateV(@NotNull Arena arena, float value0, float... values)
static @Nullable FloatPtr	checked(@NotNull MemorySegment segment)
static @NotNull FloatPtr	checked(@NotNull FloatBuffer buffer)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
@NotNull Iterator<Float>	iterator()
@NotNull FloatPtr	offset(long offset)
float	read()
float	read(long index)
@NotNull FloatPtr	reinterpret(long newSize)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
long	size()
@NotNull FloatPtr	slice(long end)
@NotNull FloatPtr	slice(long start, long end)
final String	toString()	Returns a string representation of this record class.
void	write(float value)
void	write(float @NotNull [] array)
void	write(long index, float value)
void	writeV(float value0, float @NotNull ... values)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

FloatPtr

public FloatPtr(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a FloatPtr record class.

Parameters:

segment - the value for the segment record component

Method Details

size

public long size()

read

public float read()

write

public void write(float value)

read

public float read(long index)

write

public void write(long index,
 float value)

write

public void write(float @NotNull [] array)

writeV

public void writeV(float value0,
 float @NotNull ... values)

reinterpret

@Unsafe
@NotNull
public @NotNull FloatPtr reinterpret(long newSize)

offset

@NotNull
public @NotNull FloatPtr offset(long offset)

slice

@NotNull
public @NotNull FloatPtr slice(long start,
 long end)

slice

@NotNull
public @NotNull FloatPtr slice(long end)

iterator

@NotNull
public @NotNull Iterator<Float> iterator()

Specified by:

iterator in interface Iterable<Float>

checked

@Nullable
public static @Nullable FloatPtr checked(@NotNull
 @NotNull MemorySegment segment)

checked

@NotNull
public static @NotNull FloatPtr checked(@NotNull
 @NotNull FloatBuffer buffer)

allocate

@NotNull
public static @NotNull FloatPtr allocate(@NotNull
 @NotNull Arena arena)

allocate

@NotNull
public static @NotNull FloatPtr allocate(@NotNull
 @NotNull Arena arena,
 long size)

allocate

@NotNull
public static @NotNull FloatPtr allocate(@NotNull
 @NotNull Arena arena,
 float @NotNull [] array)

allocate

@NotNull
public static @NotNull FloatPtr allocate(@NotNull
 @NotNull Arena arena,
 Collection<Float> floats)

allocateV

@NotNull
public static @NotNull FloatPtr allocateV(@NotNull
 @NotNull Arena arena,
 float value0,
 float... values)

allocate

@NotNull
public static @NotNull FloatPtr allocate(@NotNull
 @NotNull Arena arena,
 @NotNull
 @NotNull FloatBuffer buffer)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

segment

@NotNull
public @NotNull MemorySegment segment()

Returns the value of the segment record component.

Specified by:

segment in interface IPointer

Returns:

the value of the segment record component