Difference between revisions of "Real (MathObject Class)"

From WeBWorK_wiki
Jump to navigation Jump to search
(Changed headings a bit)
(Added Parser::Number::NoDecimals example)
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
=== Real class ===
 
=== Real class ===
   
The Real class implements real numbers with "fuzzy" comparison (governed by the same tolerances and settings that control student answer checking). For example, <code>Real(1.0) == Real(1.0000001)</code> will be true, while <code>Real(1.0) &lt; Real(1.0000001)</code> will be false.
+
The Real class implements real numbers with "fuzzy" comparison (governed by the same tolerances and settings that control student answer checking). For example, <code>Real(1.0) == Real(1.0000001)</code> will be true, while <code>Real(1.0) &lt; Real(1.0000001)</code> will be false. Reals can be created in any Context, but the <code>Numeric</code> Context is the most frequently used for Reals.
   
   
Line 38: Line 38:
 
ANS(Real(2)->cmp);
 
ANS(Real(2)->cmp);
   
The Real class supports the common [[Answer_Checker_Options_(MathObjects)| answer-checker options]], and the following additional options:
+
The Real class supports the [[Answer_Checker_Options_(MathObjects)| common answer-checker options]], and the following additional options:
   
 
{| class="wikitable"
 
{| class="wikitable"
Line 51: Line 51:
 
=== Methods ===
 
=== Methods ===
   
As with all MathObjects, the Real object supports the common [[MathObject_Methods_and_Properties| MathObject methods]]. There are no additional methods for this class.
+
The Real class supports the [[Common MathObject Methods]]. There are no additional methods for this class.
  +
  +
The command
  +
  +
Parser::Number::NoDecimals();
  +
  +
will add a check so that a number with decimal places is not allowed. This can be used to require students to enter values in terms of `pi` or `sqrt(2)` for example. You can also supply a Context as an argument to disallow decimals in that context:
  +
  +
Parser::Number::NoDecimals($context);
  +
  +
Without a parameter, the current context is assumed.
   
   
 
=== Properties ===
 
=== Properties ===
   
As with all MathObjects, the Real object supports the common [[MathObject_Methods_and_Properties| MathObject properties]], and the following additional ones:
+
The Real class supports the [[Common MathObject Properties]], and the following additional ones:
   
 
{| class="wikitable"
 
{| class="wikitable"

Latest revision as of 16:29, 4 February 2013

Real class

The Real class implements real numbers with "fuzzy" comparison (governed by the same tolerances and settings that control student answer checking). For example, Real(1.0) == Real(1.0000001) will be true, while Real(1.0) < Real(1.0000001) will be false. Reals can be created in any Context, but the Numeric Context is the most frequently used for Reals.


Creation

Reals are created via the Real() function, or by Compute(). Reals can be added, subtracted, and so on, and the results will still be MathObject Reals. Similarly, sin(), sqrt(), ln(), and the other functions return Real objects if their arguments are Reals. For example:

   Context("Numeric");
   
   $a = Real(2);
   $b = $a + 5;     # same as Real(7);
   $c = sqrt($a);   # same as Real(sqrt(2));

This allows you to compute with Reals just as you would with native Perl real numbers.


Pre-defined Reals

The value pi can be used in your Perl code to represent the value of [math]\pi[/math]. Note that you must use -(pi) for [math]-\pi[/math] in Perl expressions (but not in strings that will be parsed by MathObjects, such as student answers or arguments to Compute()). For instance:

   $a = pi + 2;              # same as Real("pi + 2");
   $b = 2 - (pi);            # same as Real("2 - pi");
   $c = sin(pi/2);           # same as Real(1);
   $d = Compute("2 - pi");   # parens only needed in Perl expressions

The value e, for the base of the natural log, [math]e[/math], can be used in student answers and parsed strings.

   $e = Compute("e");
   $p = Compute("e^2");


Answer Checker

As with all MathObjects, you obtain an answer checker for a Real object via the cmp() method:

   ANS(Real(2)->cmp);

The Real class supports the common answer-checker options, and the following additional options:

Option Description Default
ignoreInfinity => 1 or 0 Do/don't report type mismatches if the student enters an infinity. 1


Methods

The Real class supports the Common MathObject Methods. There are no additional methods for this class.

The command

   Parser::Number::NoDecimals();

will add a check so that a number with decimal places is not allowed. This can be used to require students to enter values in terms of `pi` or `sqrt(2)` for example. You can also supply a Context as an argument to disallow decimals in that context:

   Parser::Number::NoDecimals($context);

Without a parameter, the current context is assumed.


Properties

The Real class supports the Common MathObject Properties, and the following additional ones:

Property Description Default
$r->{period} When set, this value indicates that the real is periodic, with period given by this value. So angles might use period set to 2*pi.

Example:

$r = Real(pi/3)->with(period => 2*pi);
$r == 7*pi/3; # will be true
undef
$r->{logPeriodic} When period is defined, and logPeriodic is set to 1 this indicates that the periodicity is logarithmic (i.e., the period refers to the log of the value, not the value itself).

Example:

$r = Real(4)->with(period => 10, logPeriodic => 1);
$r == 88105; # true since 88105 is nearly exp(10+log(4))
0