The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

Name

SPVM::R::NDArray::Byte - N-Dimensional Array of byte Type.

Description

R::NDArray::Byte class in SPVM represents n-dimensional array of byte type.

Usage

  use R::NDArray::Byte;
  
  my $ndarray = R::NDArray::Byte->new({data => [(byte)1, 2, 3, 4, 5, 6], dim => [3, 2]});

Super Class

R::NDArray

Field

data

method data : byte[] ();

Same as R::NDArray#data method, but the return type is different.

Class Methods

new

static method new : R::NDArray::Byte ($options : object[] = undef);

Creates a new R::NDArray::Byte given the options $options and returns it.

This method calls R::NDArray#init method given the options $options.

Instance Methods

create_default_data

method create_default_data : byte[] ($length : int = 0);

Creates a default data given the length $length and returns it.

The default data is created by the following code.

  my $default_data = new byte[$length];

Exceptions:

The length $length must be more than or equal to 0. Otherwise an exception is thrown.

elem_to_string

method elem_to_string : string ($data : byte[], $data_index : int);

Converts an element $data at index $data_index to a string and returns it.

The string is created by the following code.

  my $string = (string)$data->[$data_index];

elem_assign

method elem_assign : void ($dist_data : byte[], $dist_data_index : int, $src_data : byte[], $src_data_index : int);

Assigns the element $src_data at index $src_data_index to the element $dist_data at index $dist_data_index.

elem_clone

method elem_clone : void ($dist_data : byte[], $dist_data_index : int, $src_data : byte[], $src_data_index : int);

Same as "elem_assign" method.

elem_cmp

method elem_cmp : int ($a_data : byte[], $a_data_index : int, $b_data : byte[], $b_data_index : int);

Compares the element $a_data at index $a_data_index and the element $b_data at index $b_data_index using the comparison operator <=> and returns the result.

elem_is_na

method elem_is_na : int ($data : byte[], $data_index : int);

Checks if an element represets NA.

Always returns 0.

clone

method clone : R::NDArray::Byte ($shallow : int = 0);

Same as R::NDArray#clone method, but the return type is different.

slice

method slice : R::NDArray::Byte ($indexes_product : R::NDArray::Int[]);

Same as R::NDArray#slice method, but the return type is different.

to_int_ndarray

method to_int_ndarray : R::NDArray::Int ();

Converts this n-dimensional array to a n-dimensional array of R::NDArray::Int and returns it.

Each element is converted by the following code.

  my $ret_elem = (int)$elem;

See Also

Copyright & License

Copyright (c) 2024 Yuki Kimoto

MIT License