.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Moose::Meta::Attribute::Native::Trait::Number 3pm"
.TH Moose::Meta::Attribute::Native::Trait::Number 3pm 2024-01-21 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Moose::Meta::Attribute::Native::Trait::Number \- Helper trait for Num attributes
.SH VERSION
.IX Header "VERSION"
version 2.2207
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&  package Real;
\&  use Moose;
\&
\&  has \*(Aqinteger\*(Aq => (
\&      traits  => [\*(AqNumber\*(Aq],
\&      is      => \*(Aqro\*(Aq,
\&      isa     => \*(AqNum\*(Aq,
\&      default => 5,
\&      handles => {
\&          set => \*(Aqset\*(Aq,
\&          add => \*(Aqadd\*(Aq,
\&          sub => \*(Aqsub\*(Aq,
\&          mul => \*(Aqmul\*(Aq,
\&          div => \*(Aqdiv\*(Aq,
\&          mod => \*(Aqmod\*(Aq,
\&          abs => \*(Aqabs\*(Aq,
\&      },
\&  );
\&
\&  my $real = Real\->new();
\&  $real\->add(5);    # same as $real\->integer($real\->integer + 5);
\&  $real\->sub(2);    # same as $real\->integer($real\->integer \- 2);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This trait provides native delegation methods for numbers. All of the
operations correspond to arithmetic operations like addition or
multiplication.
.SH "DEFAULT TYPE"
.IX Header "DEFAULT TYPE"
If you don't provide an \f(CW\*(C`isa\*(C'\fR value for your attribute, it will default to
\&\f(CW\*(C`Num\*(C'\fR.
.SH "PROVIDED METHODS"
.IX Header "PROVIDED METHODS"
All of these methods modify the attribute's value in place. All methods return
the new value.
.IP \(bu 4
\&\fBadd($value)\fR
.Sp
Adds the current value of the attribute to \f(CW$value\fR.
.IP \(bu 4
\&\fBsub($value)\fR
.Sp
Subtracts \f(CW$value\fR from the current value of the attribute.
.IP \(bu 4
\&\fBmul($value)\fR
.Sp
Multiplies the current value of the attribute by \f(CW$value\fR.
.IP \(bu 4
\&\fBdiv($value)\fR
.Sp
Divides the current value of the attribute by \f(CW$value\fR.
.IP \(bu 4
\&\fBmod($value)\fR
.Sp
Returns the current value of the attribute modulo \f(CW$value\fR.
.IP \(bu 4
\&\fBabs\fR
.Sp
Sets the current value of the attribute to its absolute value.
.SH BUGS
.IX Header "BUGS"
See "BUGS" in Moose for details on reporting bugs.
.SH AUTHORS
.IX Header "AUTHORS"
.IP \(bu 4
Stevan Little <stevan@cpan.org>
.IP \(bu 4
Dave Rolsky <autarch@urth.org>
.IP \(bu 4
Jesse Luehrs <doy@cpan.org>
.IP \(bu 4
Shawn M Moore <sartak@cpan.org>
.IP \(bu 4
יובל קוג'מן (Yuval Kogman) <nothingmuch@woobling.org>
.IP \(bu 4
Karen Etheridge <ether@cpan.org>
.IP \(bu 4
Florian Ragwitz <rafl@debian.org>
.IP \(bu 4
Hans Dieter Pearcey <hdp@cpan.org>
.IP \(bu 4
Chris Prather <chris@prather.org>
.IP \(bu 4
Matt S Trout <mstrout@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2006 by Infinity Interactive, Inc.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.