[system] / trunk / pg / lib / Value.pm Repository:
ViewVC logotype

Annotation of /trunk/pg/lib/Value.pm

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2612 - (view) (download) (as text)

1 : sh002i 2558 package Value;
2 :     my $pkg = 'Value';
3 : dpvc 2579 use vars qw($context $defaultContext %Type);
4 : sh002i 2558 use strict;
5 :    
6 : dpvc 2579 #############################################################
7 : sh002i 2558 #
8 : dpvc 2579 # Initialize the context
9 :     #
10 : sh002i 2558
11 : dpvc 2579 use Value::Context;
12 :    
13 :     $defaultContext = Value::Context->new(
14 :     lists => {
15 :     'Point' => {open => '(', close => ')'},
16 :     'Vector' => {open => '<', close => '>'},
17 :     'Matrix' => {open => '[', close => ']'},
18 :     'List' => {open => '(', close => ')'},
19 :     },
20 :     flags => {
21 :     #
22 :     # For vectors:
23 :     #
24 :     ijk => 0, # print vectors as <...>
25 :     #
26 :     # For fuzzy reals:
27 :     #
28 :     useFuzzyReals => 1,
29 :     tolerance => 1E-6,
30 :     tolType => 'relative',
31 :     zeroLevel => 1E-14,
32 :     zeroLevelTol => 1E-12,
33 : dpvc 2596 #
34 :     # word to use for infinity
35 :     #
36 :     infiniteWord => 'infinity',
37 : dpvc 2579 },
38 :     );
39 :    
40 :     $context = \$defaultContext;
41 :    
42 :    
43 : sh002i 2558 #
44 :     # Precedence of the various types
45 :     # (They will be promoted upward automatically when needed)
46 :     #
47 : dpvc 2579 $$context->{precedence} = {
48 : dpvc 2603 'Number' => 0,
49 :     'Real' => 1,
50 :     'Infinity' => 2,
51 :     'Complex' => 3,
52 :     'Point' => 4,
53 :     'Vector' => 5,
54 :     'Matrix' => 6,
55 :     'List' => 7,
56 :     'Interval' => 8,
57 :     'Union' => 9,
58 : dpvc 2609 'String' => 10,
59 :     'Formula' => 11,
60 : dpvc 2579 };
61 : sh002i 2558
62 :     #
63 :     # Binding of perl operator to class method
64 :     #
65 : dpvc 2579 $$context->{method} = {
66 : sh002i 2558 '+' => 'add',
67 :     '-' => 'sub',
68 :     '*' => 'mult',
69 :     '/' => 'div',
70 :     '**' => 'power',
71 :     '.' => '_dot', # see _dot below
72 :     'x' => 'cross',
73 :     '<=>' => 'compare',
74 : dpvc 2579 };
75 : sh002i 2558
76 : dpvc 2601 $$context->{pattern}{infinite} = '[-+]?inf(?:inity)?';
77 :     $$context->{pattern}{infinity} = '\+?inf(?:inity)?';
78 :     $$context->{pattern}{-infinity} = '-inf(?:inity)?';
79 : dpvc 2596
80 : dpvc 2579 push(@{$$context->{data}{values}},'method','precedence');
81 : sh002i 2558
82 : dpvc 2579 #############################################################
83 :    
84 : sh002i 2558 #
85 :     # Check if a value is a number, complex, etc.
86 :     #
87 : dpvc 2603 sub matchNumber {my $n = shift; $n =~ m/^$$context->{pattern}{signedNumber}$/i}
88 :     sub matchInfinite {my $n = shift; $n =~ m/^$$context->{pattern}{infinite}$/i}
89 : dpvc 2579 sub isReal {class(shift) eq 'Real'}
90 :     sub isComplex {class(shift) eq 'Complex'}
91 :     sub isFormula {class(shift) eq 'Formula'}
92 :     sub isValue {ref(shift) =~ m/^Value::/}
93 : sh002i 2558
94 :     sub isNumber {
95 :     my $n = shift;
96 : dpvc 2579 return $n->{tree}->isNumber if isFormula($n);
97 :     return isReal($n) || isComplex($n) || matchNumber($n);
98 : sh002i 2558 }
99 :    
100 :     sub isRealNumber {
101 :     my $n = shift;
102 : dpvc 2579 return $n->{tree}->isRealNumber if isFormula($n);
103 :     return isReal($n) || matchNumber($n);
104 : sh002i 2558 }
105 :    
106 :     #
107 : dpvc 2603 # Convert non-Value objects to Values, if possible
108 :     #
109 :     sub makeValue {
110 :     my $x = shift;
111 :     return $x if ref($x);
112 :     return Value::Real->make($x) if matchNumber($x);
113 : dpvc 2609 if (matchInfinite($x)) {
114 :     my $I = Value::Infinity->new();
115 :     $I = $I->neg if $x =~ m/^$$Value::context->{pattern}{-infinity}$/;
116 :     return $I;
117 :     }
118 :     if ($Parser::installed) {return $x unless $$Value::context->{strings}{$x}}
119 :     return Value::String->make($x);
120 : dpvc 2603 }
121 :    
122 :     #
123 : sh002i 2558 # Get a printable version of the class of an object
124 :     #
125 :     sub showClass {
126 : dpvc 2603 my $value = makeValue(shift);
127 : sh002i 2558 return "'".$value."'" unless ref($value);
128 :     my $class = class($value);
129 : dpvc 2604 $class = 'Infinity' if $class eq 'Formula' &&
130 :     $value->{tree} && $value->{tree}{isInfinite};
131 : dpvc 2592 $class .= ' Number' if $class =~ m/^(Real|Complex)$/;
132 :     $class .= ' of Intervals' if $class eq 'Union';
133 : dpvc 2609 $class = 'Word' if $class eq 'String';
134 : sh002i 2558 return showType($value->{tree}) if $class eq 'Formula';
135 : dpvc 2603 return 'an '.$class if $class =~ m/^[aeio]/i;
136 : sh002i 2558 return 'a '.$class;
137 :     }
138 :    
139 :     #
140 :     # Get a printable version of the type of an object
141 :     #
142 :     sub showType {
143 :     my $value = shift;
144 :     my $type = $value->type;
145 : dpvc 2609 return 'a Word' if $type eq 'String';
146 : sh002i 2558 return 'a Complex Number' if $value->isComplex;
147 : dpvc 2603 return 'an '.$type if $type =~ m/^[aeio]/i;
148 : sh002i 2558 return 'a '.$type;
149 :     }
150 :    
151 :     #
152 : dpvc 2603 # Return a string describing a value's type
153 : sh002i 2558 #
154 :     sub getType {
155 :     my $equation = shift; my $value = shift;
156 :     my $strings = $equation->{context}{strings};
157 :     if (ref($value) eq 'ARRAY') {
158 :     return 'Interval' if ($value->[0] =~ m/^[(\[]$/ && $value->[-1] =~ m/^[)\]]$/);
159 :     my ($type,$ltype);
160 :     foreach my $x (@{$value}) {
161 :     $type = getType($equation,$x);
162 :     if ($type eq 'value') {
163 :     $type = $x->type if $x->class eq 'Formula';
164 :     $type = 'Number' if $x->class eq 'Complex' || $type eq 'Complex';
165 :     }
166 :     $ltype = $type if $ltype eq '';
167 :     return 'List' if $type ne $ltype;
168 :     }
169 :     return 'Point' if $ltype eq 'Number';
170 :     return 'Matrix' if $ltype =~ m/Point|Matrix/;
171 :     return 'List';
172 :     }
173 :     elsif (Value::isFormula($value)) {return 'Formula'}
174 : dpvc 2605 elsif (Value::class($value) eq 'Infinity') {return 'String'}
175 : dpvc 2612 elsif (Value::isReal($value)) {return 'Number'}
176 : sh002i 2558 elsif (Value::isValue($value)) {return 'value'}
177 :     elsif (ref($value)) {return 'unknown'}
178 :     elsif (defined($strings->{$value})) {return 'String'}
179 :     elsif (Value::isNumber($value)) {return 'Number'}
180 :     return 'unknown';
181 :     }
182 :    
183 :     #
184 :     # Get a string describing a value's type,
185 :     # and convert the value to a Value object (if needed)
186 :     #
187 :     sub getValueType {
188 :     my $equation = shift; my $value = shift;
189 :     my $type = Value::getType($equation,$value);
190 :     if ($type eq 'String') {$type = $Value::Type{string}}
191 :     elsif ($type eq 'Number') {$type = $Value::Type{number}}
192 :     elsif ($type eq 'value') {$type = $value->typeRef}
193 :     elsif ($type =~ m/unknown|Formula/) {
194 :     $equation->Error("Can't convert ".Value::showClass($value)." to a constant");
195 :     } else {
196 :     $type = 'Value::'.$type, $value = $type->new(@{$value}) unless $type eq 'value';
197 :     $type = $value->typeRef;
198 :     }
199 :     return ($value,$type);
200 :     }
201 :    
202 :     #
203 :     # Convert a list of values to a list of formulas (called by Parser::Value)
204 :     #
205 :     sub toFormula {
206 :     my $formula = shift;
207 :     my $processed = 0;
208 :     my @f = (); my $vars = {};
209 :     foreach my $x (@_) {
210 :     if (isFormula($x)) {
211 :     $formula->{context} = $x->{context}, $processed = 1 unless $processed;
212 :     $formula->{variables} = {%{$formula->{variables}},%{$x->{variables}}};
213 :     push(@f,$x->{tree}->copy($formula));
214 :     } else {
215 :     push(@f,Parser::Value->new($formula,$x));
216 :     }
217 :     }
218 :     return (@f);
219 :     }
220 :    
221 :     #
222 :     # Convert a list of values (and open and close parens)
223 :     # to a formula whose type is the list type associated with
224 :     # the parens. If the formula is constant, evaluate it.
225 :     #
226 :     sub formula {
227 :     my $self = shift; my $values = shift;
228 :     my $class = $self->class;
229 : dpvc 2579 my $list = $$context->lists->get($class);
230 :     my $open = $list->{'open'};
231 :     my $close = $list->{'close'};
232 : sh002i 2558 my $formula = Value::Formula->blank;
233 :     my @coords = Value::toFormula($formula,@{$values});
234 :     $formula->{tree} = Parser::List->new($formula,[@coords],0,
235 :     $formula->{context}{parens}{$open},$coords[0]->typeRef,$open,$close);
236 : dpvc 2579 # return $formula->eval if scalar(%{$formula->{variables}}) == 0;
237 : sh002i 2558 return $formula;
238 :     }
239 :    
240 :     #
241 :     # A shortcut for new() that creates an instance of the object,
242 :     # but doesn't do the error checking. We assume the data are already
243 :     # known to be good.
244 :     #
245 :     sub make {
246 :     my $self = shift; my $class = ref($self) || $self;
247 :     bless {data => [@_]}, $class;
248 :     }
249 :    
250 :     #
251 :     # Return a type structure for the item
252 :     # (includes name, length of vectors, and so on)
253 :     #
254 :     sub Type {
255 :     my $name = shift; my $length = shift; my $entryType = shift;
256 :     $length = 1 unless defined $length;
257 :     return {name => $name, length => $length, entryType => $entryType,
258 :     list => (defined $entryType), @_};
259 :     }
260 :    
261 :     #
262 :     # Some predefined types
263 :     #
264 :     %Type = (
265 :     number => Value::Type('Number',1),
266 :     complex => Value::Type('Number',2),
267 :     string => Value::Type('String',1),
268 :     unknown => Value::Type('unknown',0,undef,list => 1)
269 :     );
270 :    
271 :     #
272 :     # Return various information about the object
273 :     #
274 :     sub value {return @{(shift)->{data}}} # the value of the object (as an array)
275 :     sub data {return (shift)->{data}} # the reference to the value
276 :     sub length {return (shift)->typeRef->{length}} # the number of coordinates
277 :     sub type {return (shift)->typeRef->{name}} # the object type
278 :     sub entryType {return (shift)->typeRef->{entryType}} # the coordinate type
279 :     #
280 :     # The the full type-hash for the item
281 :     #
282 :     sub typeRef {
283 :     my $self = shift;
284 :     return Value::Type($self->class, $self->length, $Value::Type{number});
285 :     }
286 :     #
287 :     # The Value.pm object class
288 :     #
289 :     sub class {
290 :     my $self = shift; my $class = ref($self) || $self;
291 :     $class =~ s/Value:://;
292 :     return $class;
293 :     }
294 :    
295 :     #
296 :     # Get an element from a point, vector, matrix, or list
297 :     #
298 :     sub extract {
299 :     my $M = shift; my $i;
300 :     while (scalar(@_) > 0) {
301 :     return unless Value::isValue($M);
302 :     $i = shift; $i-- if $i > 0;
303 :     Value::Error("Can't extract element number '$i' (index must be an integer)")
304 :     unless $i =~ m/^-?\d+$/;
305 :     $M = $M->data->[$i];
306 :     }
307 :     return $M;
308 :     }
309 :    
310 :    
311 :     #
312 :     # Promote an operand to the same precedence as the current object
313 :     #
314 :     sub promotePrecedence {
315 :     my $self = shift; my $other = shift;
316 : dpvc 2579 my $sprec = $$context->{precedence}{class($self)};
317 :     my $oprec = $$context->{precedence}{class($other)};
318 : sh002i 2558 return defined($oprec) && $sprec < $oprec;
319 :     }
320 :    
321 : dpvc 2592 sub promote {shift}
322 :    
323 : sh002i 2558 #
324 :     # Default stub to call when no function is defined for an operation
325 :     #
326 :     sub nomethod {
327 :     my ($l,$r,$flag,$op) = @_;
328 : dpvc 2579 my $call = $$context->{method}{$op};
329 : sh002i 2558 if (defined($call) && $l->promotePrecedence($r)) {return $r->$call($l,!$flag)}
330 :     my $error = "Can't use '$op' with ".$l->class."-valued operands";
331 :     $error .= " (use '**' for exponentiation)" if $op eq '^';
332 :     Value::Error($error);
333 :     }
334 :    
335 :     #
336 :     # Stubs for the sub-classes
337 :     #
338 :     sub add {nomethod(@_,'+')}
339 :     sub sub {nomethod(@_,'-')}
340 :     sub mult {nomethod(@_,'*')}
341 :     sub div {nomethod(@_,'/')}
342 :     sub power {nomethod(@_,'**')}
343 :     sub cross {nomethod(@_,'x')}
344 :    
345 :     #
346 :     # If the right operand is higher precedence, we switch the order.
347 :     #
348 :     # If the right operand is also a Value object, we do the object's
349 :     # dot method to combine the two objects of the same class.
350 :     #
351 :     # Otherwise, since . is used for string concatenation, we want to retain
352 :     # that. Since the resulting string is often used in Formula and will be
353 : dpvc 2579 # parsed again, we put parentheses around the values to guarantee that
354 : sh002i 2558 # the values will be treated as one mathematical unit. For example, if
355 :     # $f = Formula("1+x") and $g = Formula("y") then Formula("$f/$g") will be
356 :     # (1+x)/y not 1+(x/y), as it would be without the implicit parentheses.
357 :     #
358 :     sub _dot {
359 :     my ($l,$r,$flag) = @_;
360 :     return Value::_dot($r,$l,!$flag) if ($l->promotePrecedence($r));
361 :     return $l->dot($r,$flag) if (Value::isValue($r));
362 : dpvc 2606 $l = $l->stringify; $l = '('.$l.')' unless $$Value::context->flag('StringifyAsTeX');
363 : sh002i 2558 return ($flag)? ($r.$l): ($l.$r);
364 :     }
365 :     #
366 :     # Some classes override this
367 :     #
368 : dpvc 2603 sub dot {
369 : sh002i 2558 my ($l,$r,$flag) = @_;
370 : dpvc 2606 my $tex = $$Value::context->flag('StringifyAsTeX');
371 :     $l = $l->stringify; $l = '('.$l.')' if $tex;
372 :     if (ref($r)) {$r = $r->stringify; $r = '('.$l.')' if $tex}
373 : sh002i 2558 return ($flag)? ($r.$l): ($l.$r);
374 :     }
375 :    
376 :     #
377 :     # Compare the values of the objects
378 :     # (list classes should replace this)
379 :     #
380 :     sub compare {
381 :     my ($l,$r,$flag) = @_;
382 :     if ($l->promotePrecedence($r)) {return $r->compare($l,!$flag)}
383 :     return $l->value <=> $r->value;
384 :     }
385 :    
386 :     #
387 :     # Generate the various output formats
388 : dpvc 2606 # (can be replaced by sub-classes)
389 : sh002i 2558 #
390 : dpvc 2606 sub stringify {
391 :     my $self = shift;
392 :     return $self->TeX() if $$Value::context->flag('StringifyAsTeX');
393 : dpvc 2612 $self->string;
394 : dpvc 2606 }
395 :     sub string {shift->value}
396 :     sub TeX {shift->string(@_)}
397 : sh002i 2558 #
398 :     # For perl, call the appropriate constructor around the objects data
399 :     #
400 :     sub perl {
401 :     my $self = shift; my $parens = shift; my $matrix = shift;
402 :     my $class = $self->class; my $mtype = $class eq 'Matrix';
403 :     my $perl; my @p = ();
404 :     foreach my $x (@{$self->data}) {
405 :     if (Value::isValue($x)) {push(@p,$x->perl(0,$mtype))} else {push(@p,$x)}
406 :     }
407 :     @p = ("'".$self->{open}."'",@p,"'".$self->{close}."'") if $class eq 'Interval';
408 :     if ($matrix) {
409 :     $perl = '['.join(',',@p).']';
410 :     } else {
411 :     $perl = $class.'('.join(',',@p).')';
412 :     $perl = '('.$perl.')' if $parens == 1;
413 :     }
414 :     return $perl;
415 :     }
416 :    
417 :     #
418 :     # Stubs for when called by Parser
419 :     #
420 :     sub eval {shift}
421 :     sub reduce {shift}
422 :    
423 : dpvc 2579 sub ijk {
424 :     Value::Error("Can't use method 'ijk' with objects of type '".(shift)->class."'");
425 :     }
426 :    
427 : sh002i 2558 #
428 :     # Report an error
429 :     #
430 :     sub Error {
431 :     my $message = shift;
432 : dpvc 2579 $$context->setError($message,'');
433 : dpvc 2592 # die $message . traceback();
434 :     die $message . getCaller();
435 : sh002i 2558 }
436 :    
437 :     #
438 :     # Try to locate the line and file where the error occurred
439 :     #
440 :     sub getCaller {
441 :     my $frame = 2;
442 :     while (my ($pkg,$file,$line,$subname) = caller($frame++)) {
443 :     return " at line $line of $file\n"
444 :     unless $pkg =~ /^(Value|Parser)/ ||
445 :     $subname =~ m/^(Value|Parser).*(new|call)$/;
446 :     }
447 :     return "";
448 :     }
449 :    
450 : dpvc 2579 #
451 :     # For debugging
452 :     #
453 :     sub traceback {
454 :     my $frame = 2;
455 :     my $trace = '';
456 :     while (my ($pkg,$file,$line,$subname) = caller($frame++))
457 :     {$trace .= " in $subname at line $line of $file\n"}
458 :     return $trace;
459 :     }
460 :    
461 : sh002i 2558 ###########################################################################
462 :     #
463 :     # Load the sub-classes.
464 :     #
465 :    
466 : dpvc 2579 use Value::Real;
467 : sh002i 2558 use Value::Complex;
468 : dpvc 2603 use Value::Infinity;
469 : sh002i 2558 use Value::Point;
470 :     use Value::Vector;
471 :     use Value::Matrix;
472 :     use Value::List;
473 :     use Value::Interval;
474 :     use Value::Union;
475 : dpvc 2609 use Value::String;
476 : sh002i 2558 # use Value::Formula;
477 :    
478 : dpvc 2592 use Value::AnswerChecker; # for WeBWorK
479 :    
480 : sh002i 2558 ###########################################################################
481 : dpvc 2592
482 :     use vars qw($installed);
483 :     $Value::installed = 1;
484 :    
485 :     ###########################################################################
486 :     ###########################################################################
487 : dpvc 2576 #
488 :     # To Do:
489 :     #
490 : dpvc 2579 # Make Complex class include more of Complex1.pm
491 :     # Make better interval comparison
492 : dpvc 2576 #
493 :     ###########################################################################
494 : sh002i 2558
495 : dpvc 2592 1;

aubreyja at gmail dot com
ViewVC Help
Powered by ViewVC 1.0.9