Skip to content

Updates to documentation #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mohawk2 merged 1 commit into from
Sep 5, 2026
Merged

Updates to documentation #38

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions lib/Data/Frame.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ around BUILDARGS($orig, $class : @args) {
}
else {
die
"Column piddles must all be same length or have a length of 1";
"Column ndarrays must all be same length or have a length of 1";
}
}
}
Expand Down Expand Up @@ -281,7 +281,7 @@ C<($nrow, $ncol)>.

shape()

Similar to C<dims> but returns a piddle.
Similar to C<dims> but returns an ndarray.

=cut

Expand All @@ -295,7 +295,7 @@ method shape () {

=head2 at

my $column_piddle = $df->at($column_indexer);
my $column_ndarray = $df->at($column_indexer);
my $cell_value = $df->at($row_indexer, $column_indexer);

If only one argument is given, it would treat the argument as column
Expand Down Expand Up @@ -857,7 +857,7 @@ This method returns an lvalue which allows PDL-like C<.=> assignment for
changing a subset of the raw data frame. For example,

$df->slice($row_indexer, $column_indexer) .= $another_df;
$df->slice($row_indexer, $column_indexer) .= $piddle;
$df->slice($row_indexer, $column_indexer) .= $ndarray;

If a given argument is non-indexer, it would try guessing if the argument
is numeric or not, and coerce it by either C<indexer_s()> or C<indexer_i()>.
Expand Down Expand Up @@ -1050,7 +1050,8 @@ Here are some examples,
bar => sub {
my ($col, $df) = @_;
$col * 3;
} );
}
} );

=item Add a new column from existing data,

Expand Down Expand Up @@ -1163,7 +1164,7 @@ Returns a new data frame.

=head2 sorti

Similar as this class's C<sort()> method but returns a piddle for row indices.
Similar as this class's C<sort()> method but returns a ndarray for row indices.

=cut

Expand Down Expand Up @@ -1295,13 +1296,13 @@ method id () {

assign( (DataFrame|Piddle) $x )

Assign another data frame or a piddle to this data frame for in-place change.
Assign another data frame or a ndarray to this data frame for in-place change.

C<$x> can be,

=for :list
* A data frame object having the same dimensions and column names as C<$self>.
* A piddle having the same number of elements as C<$self>.
* An ndarray having the same number of elements as C<$self>.

This method is internally used by the C<.=> operation, below are same,

Expand Down
Loading