File Coverage

blib/lib/Data/Sah/Filter/perl/Float/floor.pm

Criterion	Covered	Total	%
statement	8	18	44.4
branch	0	4	0.0
condition	0	4	0.0
subroutine	3	5	60.0
pod	0	2	0.0
total	11	33	33.3

package Data::Sah::Filter::perl::Float::floor;

use 5.010001;
use strict;
use warnings;

our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2024-07-17'; # DATE
our $DIST = 'Data-Sah-Filter'; # DIST
our $VERSION = '0.025'; # VERSION

sub meta {
    +{
        v => 1,
        summary => 'Round number to the nearest integer (or "nearest" argument) that is less than the number',
        args => {
            nearest => {
                schema => 'ufloat*',
            },
        },
        examples => [
            {value=>1, filtered_value=>1},
            {value=>-1.1, filtered_value=>-2},
            {value=>1.1, filtered_value=>1},
            {value=>1.6, filter_args=>{nearest=>0.5}, filtered_value=>1.5},
        ],
    };
}

sub filter {
    my %fargs = @_;

    my $dt = $fargs{data_term};
    my $gen_args = $fargs{args} // {};
    my $nearest = $gen_args->{nearest};
    $nearest += 0 if defined $nearest;

    my $res = {};
    $res->{modules}{POSIX} //= 0;
    $res->{expr_filter} = join(
        "",
        defined($nearest) ? "POSIX::floor($dt/$nearest)*$nearest" : "POSIX::floor($dt)",
    );

    $res;
}

1;
# ABSTRACT: Round number to the nearest integer (or "nearest" argument) that is less than the number

__END__