Module club.doki7.ffm

Package club.doki7.ffm.ptr

Record Class DoublePtr

java.lang.Object

java.lang.Record

club.doki7.ffm.ptr.DoublePtr

All Implemented Interfaces:

IPointer, Iterable<Double>

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static @NotNull DoublePtr	allocate(@NotNull Arena arena)
static @NotNull DoublePtr	allocate(@NotNull Arena arena, double @NotNull [] array)
static @NotNull DoublePtr	allocate(@NotNull Arena arena, long size)
static @NotNull DoublePtr	allocate(@NotNull Arena arena, @NotNull DoubleBuffer buffer)
static @NotNull DoublePtr	allocate(@NotNull Arena arena, Collection<Double> doubles)
static @NotNull DoublePtr	allocateV(@NotNull Arena arena, double value0, double... values)
static @Nullable DoublePtr	checked(@NotNull MemorySegment segment)
static @NotNull DoublePtr	checked(@NotNull DoubleBuffer 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.
PrimitiveIterator.OfDouble	iterator()
@NotNull DoublePtr	offset(long offset)
double	read()
double	read(long index)
@NotNull DoublePtr	reinterpret(long newSize)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
long	size()
@NotNull DoublePtr	slice(long end)
@NotNull DoublePtr	slice(long start, long end)
final String	toString()	Returns a string representation of this record class.
void	write(double value)
void	write(double @NotNull [] array)
void	write(long index, double value)
void	writeV(double value0, double @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

DoublePtr

public DoublePtr(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a DoublePtr record class.

Parameters:

segment - the value for the segment record component

Method Details

size

public long size()

read

public double read()

write

public void write(double value)

read

public double read(long index)

write

public void write(long index,
 double value)

write

public void write(double @NotNull [] array)

writeV

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

reinterpret

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

offset

@NotNull
public @NotNull DoublePtr offset(long offset)

slice

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

slice

@NotNull
public @NotNull DoublePtr slice(long end)

checked

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

iterator

@NotNull
public PrimitiveIterator.OfDouble iterator()

Specified by:

iterator in interface Iterable<Double>

checked

@NotNull
public static @NotNull DoublePtr checked(@NotNull
 @NotNull DoubleBuffer buffer)

allocate

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

allocate

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

allocate

@NotNull
public static @NotNull DoublePtr allocate(@NotNull
 @NotNull Arena arena,
 double @NotNull [] array)

allocate

@NotNull
public static @NotNull DoublePtr allocate(@NotNull
 @NotNull Arena arena,
 Collection<Double> doubles)

allocateV

@NotNull
public static @NotNull DoublePtr allocateV(@NotNull
 @NotNull Arena arena,
 double value0,
 double... values)

allocate

@NotNull
public static @NotNull DoublePtr allocate(@NotNull
 @NotNull Arena arena,
 @NotNull
 @NotNull DoubleBuffer 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