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

aubreyja at gmail dot com
ViewVC Help
Powered by ViewVC 1.0.9