The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

KIMOTO / SPVM-R-0.102 / lib / SPVM / R / NDArray / FloatComplex.pm 

            

              
1
2
3
4
5
—
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

              
package SPVM::R::NDArray::FloatComplex;
1;
=head1 Name
SPVM::R::NDArray::FloatComplex - N-Dimensional Array of Float Complex Type.
=head1 Description
R::NDArray::FloatComplex class in L<SPVM> represents n-dimensional array of float complex L<Complex_2f|SPVM::Complex_2f> type.
=head1 Usage
  use R::NDArray::FloatComplex;
  use Math;
   
  my $data = [
    Math->complexf(1, 0),
    Math->complexf(2, 0),
    Math->complexf(3, 0),
    Math->complexf(4, 0),
    Math->complexf(5, 0),
    Math->complexf(6, 0)
  ];
   
  my $ndarray = R::NDArray::FloatComplex->new({data => $data, dim => [3, 2]});
=head1 Super Class
L<R::NDArray|SPVM::R::NDArray>
=head1 Fields
=head2 data
C<method data : L<Complex_2f|SPVM::Complex_2f>[] ();>
Same as L<R::NDArray#data|SPVM::R::NDArray/"data"> method, but the return type is different.
=head1 Class Methods
=head2 new
C<static method new : L<R::NDArray::FloatComplex|SPVM::R::NDArray::FloatComplex> ($options : object[] = undef);>
Creates a new L<R::NDArray::FloatComplex|SPVM::R::NDArray::FloatComplex> given the options $options and returns it.
This method calls L<R::NDArray#init|SPVM::R::NDArray/"init"> method given the options $options.
=head1 Instance Methods
=head2 create_default_data
C<method create_default_data : L<Complex_2f|SPVM::Complex_2f>[] ($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 Complex_2f[$length];
Exceptions:
The length $length must be more than or equal to 0. Otherwise an exception is thrown.
=head2 elem_to_string
C<method elem_to_string : string ($data : L<Complex_2f|SPVM::Complex_2f>[], $data_index : int);>
Converts an element $data at index $data_index to a string such as C<2+3i> and returns it.
=head2 elem_assign
C<method elem_assign : void ($dist_data : L<Complex_2f|SPVM::Complex_2f>[], $dist_data_index : int, $src_data : L<Complex_2f|SPVM::Complex_2f>[], $src_data_index : int);>
Assigns the element $src_data at index $src_data_index to the element $dist_data at index $dist_data_index.
=head2 elem_clone
C<method elem_clone : void ($dist_data : L<Complex_2f|SPVM::Complex_2f>[], $dist_data_index : int, $src_data : L<Complex_2f|SPVM::Complex_2f>[], $src_data_index : int);>
Same as L</"elem_assign"> method.
=head2 elem_is_na
C<method elem_is_na : int ($data : L<Complex_2f|SPVM::Complex_2f>[], $data_index : int);>
Checks if an element represets NA.
If the real number or the image number of the element $data at index $data_index is C<NaN>, returns 1, otherwise returns 0.
=head2 clone
C<method clone : L<R::NDArray::FloatComplex|SPVM::R::NDArray::FloatComplex> ($shallow : int = 0);>
Same as L<R::NDArray#clone|SPVM::R::NDArray/"clone"> method, but the return type is different.
=head2 slice
C<method slice : L<R::NDArray::FloatComplex|SPVM::R::NDArray::FloatComplex> ($indexes_product : L<R::NDArray::Int|SPVM::R::NDArray::Int>[]);>
Same as L<R::NDArray#slice|SPVM::R::NDArray/"slice"> method, but the return type is different.
=head2 to_double_complex_ndarray
C<method to_double_complex_ndarray : L<R::NDArray::DoubleComplex|SPVM::R::NDArray::DoubleComplex> ();>
Converts this n-dimensional array to a n-dimensional array of L<R::NDArray::DoubleComplex|SPVM::R::NDArray::DoubleComplex> and returns it.
Each element is converted by the following code.
  $ret_elem->{re} = (double)$elem->{re};
  $ret_elem->{im} = (double)$elem->{im};
=head1 See Also
=over 2
=item * L<R::OP::FloatComplex|SPVM::R::OP::FloatComplex>
=item * L<R::NDArray|SPVM::R::NDArray>
=item * L<R|SPVM::R>
=back
=head1 Copyright & License
Copyright (c) 2024 Yuki Kimoto
MIT License