local-lib5/man/man3/Moose::Meta::Attribute::Native::Trait::Number.3pm

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "Moose::Meta::Attribute::Native::Trait::Number 3"
 132 .TH Moose::Meta::Attribute::Native::Trait::Number 3 "2009-11-19" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 Moose::Meta::Attribute::Native::Trait::Number \- Helper trait for Num attributes
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 2
 138 \&  package Real;
 139 \&  use Moose;
 140 .Ve
 141 .PP
 142 .Vb 15
 143 \&  has 'integer' => (
 144 \&      traits    => ['Number'],
 145 \&      is        => 'ro',
 146 \&      isa       => 'Num',
 147 \&      default   => 5,
 148 \&      handles   => {
 149 \&          set => 'set',
 150 \&          add => 'add',
 151 \&          sub => 'sub',
 152 \&          mul => 'mul',
 153 \&          div => 'div',
 154 \&          mod => 'mod',
 155 \&          abs => 'abs',
 156 \&      },
 157 \&  );
 158 .Ve
 159 .PP
 160 .Vb 3
 161 \&  my $real = Real\->new();
 162 \&  $real\->add(5); # same as $real\->integer($real\->integer + 5);
 163 \&  $real\->sub(2); # same as $real\->integer($real\->integer \- 2);
 164 .Ve
 165 .SH "DESCRIPTION"
 166 .IX Header "DESCRIPTION"
 167 This provides a simple numeric attribute, which supports most of the
 168 basic math operations.
 169 .SH "PROVIDED METHODS"
 170 .IX Header "PROVIDED METHODS"
 171 It is important to note that all those methods do in place modification of the
 172 value stored in the attribute. These methods are implemented within this
 173 package.
 174 .IP "\fBset($value)\fR" 4
 175 .IX Item "set($value)"
 176 Alternate way to set the value.
 177 .IP "\fBadd($value)\fR" 4
 178 .IX Item "add($value)"
 179 Adds the current value of the attribute to \f(CW$value\fR.
 180 .IP "\fBsub($value)\fR" 4
 181 .IX Item "sub($value)"
 182 Subtracts \f(CW$value\fR from the current value of the attribute.
 183 .IP "\fBmul($value)\fR" 4
 184 .IX Item "mul($value)"
 185 Multiplies the current value of the attribute by \f(CW$value\fR.
 186 .IP "\fBdiv($value)\fR" 4
 187 .IX Item "div($value)"
 188 Divides the current value of the attribute by \f(CW$value\fR.
 189 .IP "\fBmod($value)\fR" 4
 190 .IX Item "mod($value)"
 191 Returns the current value of the attribute modulo \f(CW$value\fR.
 192 .IP "\fBabs\fR" 4
 193 .IX Item "abs"
 194 Sets the current value of the attribute to its absolute value.
 195 .SH "METHODS"
 196 .IX Header "METHODS"
 197 .IP "\fBmeta\fR" 4
 198 .IX Item "meta"
 199 .PD 0
 200 .IP "\fBmethod_constructors\fR" 4
 201 .IX Item "method_constructors"
 202 .PD
 203 .SH "BUGS"
 204 .IX Header "BUGS"
 205 All complex software has bugs lurking in it, and this module is no
 206 exception. If you find a bug please either email me, or add the bug
 207 to cpan\-RT.
 208 .SH "AUTHOR"
 209 .IX Header "AUTHOR"
 210 Robert Boone
 211 .SH "COPYRIGHT AND LICENSE"
 212 .IX Header "COPYRIGHT AND LICENSE"
 213 Copyright 2007\-2009 by Infinity Interactive, Inc.
 214 .PP
 215 <http://www.iinteractive.com>
 216 .PP
 217 This library is free software; you can redistribute it and/or modify
 218 it under the same terms as Perl itself.