[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 2609 - (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 : sh002i 2558 elsif (Value::isValue($value)) {return 'value'}
176 :     elsif (ref($value)) {return 'unknown'}
177 :     elsif (defined($strings->{$value})) {return 'String'}
178 :     elsif (Value::isNumber($value)) {return 'Number'}
179 :     return 'unknown';
180 :     }
181 :    
182 :     #
183 :     # Get a string describing a value's type,
184 :     # and convert the value to a Value object (if needed)
185 :     #
186 :     sub getValueType {
187 :     my $equation = shift; my $value = shift;
188 :     my $type = Value::getType($equation,$value);
189 :     if ($type eq 'String') {$type = $Value::Type{string}}
190 :     elsif ($type eq 'Number') {$type = $Value::Type{number}}
191 :     elsif ($type eq 'value') {$type = $value->typeRef}
192 :     elsif ($type =~ m/unknown|Formula/) {
193 :     $equation->Error("Can't convert ".Value::showClass($value)." to a constant");
194 :     } else {
195 :     $type = 'Value::'.$type, $value = $type->new(@{$value}) unless $type eq 'value';
196 :     $type = $value->typeRef;
197 :     }
198 :     return ($value,$type);
199 :     }
200 :    
201 :     #
202 :     # Convert a list of values to a list of formulas (called by Parser::Value)
203 :     #
204 :     sub toFormula {
205 :     my $formula = shift;
206 :     my $processed = 0;
207 :     my @f = (); my $vars = {};
208 :     foreach my $x (@_) {
209 :     if (isFormula($x)) {
210 :     $formula->{context} = $x->{context}, $processed = 1 unless $processed;
211 :     $formula->{variables} = {%{$formula->{variables}},%{$x->{variables}}};
212 :     push(@f,$x->{tree}->copy($formula));
213 :     } else {
214 :     push(@f,Parser::Value->new($formula,$x));
215 :     }
216 :     }
217 :     return (@f);
218 :     }
219 :    
220 :     #
221 :     # Convert a list of values (and open and close parens)
222 :     # to a formula whose type is the list type associated with
223 :     # the parens. If the formula is constant, evaluate it.
224 :     #
225 :     sub formula {
226 :     my $self = shift; my $values = shift;
227 :     my $class = $self->class;
228 : dpvc 2579 my $list = $$context->lists->get($class);
229 :     my $open = $list->{'open'};
230 :     my $close = $list->{'close'};
231 : sh002i 2558 my $formula = Value::Formula->blank;
232 :     my @coords = Value::toFormula($formula,@{$values});
233 :     $formula->{tree} = Parser::List->new($formula,[@coords],0,
234 :     $formula->{context}{parens}{$open},$coords[0]->typeRef,$open,$close);
235 : dpvc 2579 # return $formula->eval if scalar(%{$formula->{variables}}) == 0;
236 : sh002i 2558 return $formula;
237 :     }
238 :    
239 :     #
240 :     # A shortcut for new() that creates an instance of the object,
241 :     # but doesn't do the error checking. We assume the data are already
242 :     # known to be good.
243 :     #
244 :     sub make {
245 :     my $self = shift; my $class = ref($self) || $self;
246 :     bless {data => [@_]}, $class;
247 :     }
248 :    
249 :     #
250 :     # Return a type structure for the item
251 :     # (includes name, length of vectors, and so on)
252 :     #
253 :     sub Type {
254 :     my $name = shift; my $length = shift; my $entryType = shift;
255 :     $length = 1 unless defined $length;
256 :     return {name => $name, length => $length, entryType => $entryType,
257 :     list => (defined $entryType), @_};
258 :     }
259 :    
260 :     #
261 :     # Some predefined types
262 :     #
263 :     %Type = (
264 :     number => Value::Type('Number',1),
265 :     complex => Value::Type('Number',2),
266 :     string => Value::Type('String',1),
267 :     unknown => Value::Type('unknown',0,undef,list => 1)
268 :     );
269 :    
270 :     #
271 :     # Return various information about the object
272 :     #
273 :     sub value {return @{(shift)->{data}}} # the value of the object (as an array)
274 :     sub data {return (shift)->{data}} # the reference to the value
275 :     sub length {return (shift)->typeRef->{length}} # the number of coordinates
276 :     sub type {return (shift)->typeRef->{name}} # the object type
277 :     sub entryType {return (shift)->typeRef->{entryType}} # the coordinate type
278 :     #
279 :     # The the full type-hash for the item
280 :     #
281 :     sub typeRef {
282 :     my $self = shift;
283 :     return Value::Type($self->class, $self->length, $Value::Type{number});
284 :     }
285 :     #
286 :     # The Value.pm object class
287 :     #
288 :     sub class {
289 :     my $self = shift; my $class = ref($self) || $self;
290 :     $class =~ s/Value:://;
291 :     return $class;
292 :     }
293 :    
294 :     #
295 :     # Get an element from a point, vector, matrix, or list
296 :     #
297 :     sub extract {
298 :     my $M = shift; my $i;
299 :     while (scalar(@_) > 0) {
300 :     return unless Value::isValue($M);
301 :     $i = shift; $i-- if $i > 0;
302 :     Value::Error("Can't extract element number '$i' (index must be an integer)")
303 :     unless $i =~ m/^-?\d+$/;
304 :     $M = $M->data->[$i];
305 :     }
306 :     return $M;
307 :     }
308 :    
309 :    
310 :     #
311 :     # Promote an operand to the same precedence as the current object
312 :     #
313 :     sub promotePrecedence {
314 :     my $self = shift; my $other = shift;
315 : dpvc 2579 my $sprec = $$context->{precedence}{class($self)};
316 :     my $oprec = $$context->{precedence}{class($other)};
317 : sh002i 2558 return defined($oprec) && $sprec < $oprec;
318 :     }
319 :    
320 : dpvc 2592 sub promote {shift}
321 :    
322 : sh002i 2558 #
323 :     # Default stub to call when no function is defined for an operation
324 :     #
325 :     sub nomethod {
326 :     my ($l,$r,$flag,$op) = @_;
327 : dpvc 2579 my $call = $$context->{method}{$op};
328 : sh002i 2558 if (defined($call) && $l->promotePrecedence($r)) {return $r->$call($l,!$flag)}
329 :     my $error = "Can't use '$op' with ".$l->class."-valued operands";
330 :     $error .= " (use '**' for exponentiation)" if $op eq '^';
331 :     Value::Error($error);
332 :     }
333 :    
334 :     #
335 :     # Stubs for the sub-classes
336 :     #
337 :     sub add {nomethod(@_,'+')}
338 :     sub sub {nomethod(@_,'-')}
339 :     sub mult {nomethod(@_,'*')}
340 :     sub div {nomethod(@_,'/')}
341 :     sub power {nomethod(@_,'**')}
342 :     sub cross {nomethod(@_,'x')}
343 :    
344 :     #
345 :     # If the right operand is higher precedence, we switch the order.
346 :     #
347 :     # If the right operand is also a Value object, we do the object's
348 :     # dot method to combine the two objects of the same class.
349 :     #
350 :     # Otherwise, since . is used for string concatenation, we want to retain
351 :     # that. Since the resulting string is often used in Formula and will be
352 : dpvc 2579 # parsed again, we put parentheses around the values to guarantee that
353 : sh002i 2558 # the values will be treated as one mathematical unit. For example, if
354 :     # $f = Formula("1+x") and $g = Formula("y") then Formula("$f/$g") will be
355 :     # (1+x)/y not 1+(x/y), as it would be without the implicit parentheses.
356 :     #
357 :     sub _dot {
358 :     my ($l,$r,$flag) = @_;
359 :     return Value::_dot($r,$l,!$flag) if ($l->promotePrecedence($r));
360 :     return $l->dot($r,$flag) if (Value::isValue($r));
361 : dpvc 2606 $l = $l->stringify; $l = '('.$l.')' unless $$Value::context->flag('StringifyAsTeX');
362 : sh002i 2558 return ($flag)? ($r.$l): ($l.$r);
363 :     }
364 :     #
365 :     # Some classes override this
366 :     #
367 : dpvc 2603 sub dot {
368 : sh002i 2558 my ($l,$r,$flag) = @_;
369 : dpvc 2606 my $tex = $$Value::context->flag('StringifyAsTeX');
370 :     $l = $l->stringify; $l = '('.$l.')' if $tex;
371 :     if (ref($r)) {$r = $r->stringify; $r = '('.$l.')' if $tex}
372 : sh002i 2558 return ($flag)? ($r.$l): ($l.$r);
373 :     }
374 :    
375 :     #
376 :     # Compare the values of the objects
377 :     # (list classes should replace this)
378 :     #
379 :     sub compare {
380 :     my ($l,$r,$flag) = @_;
381 :     if ($l->promotePrecedence($r)) {return $r->compare($l,!$flag)}
382 :     return $l->value <=> $r->value;
383 :     }
384 :    
385 :     #
386 :     # Generate the various output formats
387 : dpvc 2606 # (can be replaced by sub-classes)
388 : sh002i 2558 #
389 : dpvc 2606 sub stringify {
390 :     my $self = shift;
391 :     return $self->TeX() if $$Value::context->flag('StringifyAsTeX');
392 :     $self->string();
393 :     }
394 :     sub string {shift->value}
395 :     sub TeX {shift->string(@_)}
396 : sh002i 2558 #
397 :     # For perl, call the appropriate constructor around the objects data
398 :     #
399 :     sub perl {
400 :     my $self = shift; my $parens = shift; my $matrix = shift;
401 :     my $class = $self->class; my $mtype = $class eq 'Matrix';
402 :     my $perl; my @p = ();
403 :     foreach my $x (@{$self->data}) {
404 :     if (Value::isValue($x)) {push(@p,$x->perl(0,$mtype))} else {push(@p,$x)}
405 :     }
406 :     @p = ("'".$self->{open}."'",@p,"'".$self->{close}."'") if $class eq 'Interval';
407 :     if ($matrix) {
408 :     $perl = '['.join(',',@p).']';
409 :     } else {
410 :     $perl = $class.'('.join(',',@p).')';
411 :     $perl = '('.$perl.')' if $parens == 1;
412 :     }
413 :     return $perl;
414 :     }
415 :    
416 :     #
417 :     # Stubs for when called by Parser
418 :     #
419 :     sub eval {shift}
420 :     sub reduce {shift}
421 :    
422 : dpvc 2579 sub ijk {
423 :     Value::Error("Can't use method 'ijk' with objects of type '".(shift)->class."'");
424 :     }
425 :    
426 : sh002i 2558 #
427 :     # Report an error
428 :     #
429 :     sub Error {
430 :     my $message = shift;
431 : dpvc 2579 $$context->setError($message,'');
432 : dpvc 2592 # die $message . traceback();
433 :     die $message . getCaller();
434 : sh002i 2558 }
435 :    
436 :     #
437 :     # Try to locate the line and file where the error occurred
438 :     #
439 :     sub getCaller {
440 :     my $frame = 2;
441 :     while (my ($pkg,$file,$line,$subname) = caller($frame++)) {
442 :     return " at line $line of $file\n"
443 :     unless $pkg =~ /^(Value|Parser)/ ||
444 :     $subname =~ m/^(Value|Parser).*(new|call)$/;
445 :     }
446 :     return "";
447 :     }
448 :    
449 : dpvc 2579 #
450 :     # For debugging
451 :     #
452 :     sub traceback {
453 :     my $frame = 2;
454 :     my $trace = '';
455 :     while (my ($pkg,$file,$line,$subname) = caller($frame++))
456 :     {$trace .= " in $subname at line $line of $file\n"}
457 :     return $trace;
458 :     }
459 :    
460 : sh002i 2558 ###########################################################################
461 :     #
462 :     # Load the sub-classes.
463 :     #
464 :    
465 : dpvc 2579 use Value::Real;
466 : sh002i 2558 use Value::Complex;
467 : dpvc 2603 use Value::Infinity;
468 : sh002i 2558 use Value::Point;
469 :     use Value::Vector;
470 :     use Value::Matrix;
471 :     use Value::List;
472 :     use Value::Interval;
473 :     use Value::Union;
474 : dpvc 2609 use Value::String;
475 : sh002i 2558 # use Value::Formula;
476 :    
477 : dpvc 2592 use Value::AnswerChecker; # for WeBWorK
478 :    
479 : sh002i 2558 ###########################################################################
480 : dpvc 2592
481 :     use vars qw($installed);
482 :     $Value::installed = 1;
483 :    
484 :     ###########################################################################
485 :     ###########################################################################
486 : dpvc 2576 #
487 :     # To Do:
488 :     #
489 : dpvc 2579 # Make Complex class include more of Complex1.pm
490 :     # Make better interval comparison
491 : dpvc 2576 #
492 :     ###########################################################################
493 : sh002i 2558
494 : dpvc 2592 1;

aubreyja at gmail dot com
ViewVC Help
Powered by ViewVC 1.0.9