Undefined values

From Rosetta Code
Revision as of 07:26, 17 January 2011 by Sonia (talk | contribs) (→‎{{header|Go}}: clean up. no substantial code changes.)
Task
Undefined values
You are encouraged to solve this task according to the task description, using any language you may know.

For languages which have an explicit notion of an undefined value, identify and exercise those language's mechanisms for identifying and manipulating a variable's value's status as being undefined

Ada

Works with: GNAT

Ada language provides attribute 'Valid used to check if a scalar value is valid. An invalid value may appear as a result of unchecked type conversion, input, access through a dangling pointer etc. The language also provides the configuration pragma Normalize_Scalars which instructs the compiler to initialize uninitialized scalars with values, which when possible, would have the attribute 'Valid false. This pragma is required to be applied to the whole partition, which would require recompilation of the run-time library. For this reason, the presented example uses another pragma Initialize_Scalars. This one has the effect similar to Normalize_Scalars, but is GNAT-specific: <lang Ada> pragma Initialize_Scalars; with Ada.Text_IO; use Ada.Text_IO;

procedure Invalid_Value is

  type Color is (Red, Green, Blue);
  X : Float;
  Y : Color;

begin

  if not X'Valid then
     Put_Line ("X is not valid");
  end if;
  X := 1.0;
  if X'Valid then
     Put_Line ("X is" & Float'Image (X));
  end if;   
  if not Y'Valid then
     Put_Line ("Y is not valid");
  end if;
  Y := Green;
  if Y'Valid then
     Put_Line ("Y is " & Color'Image (Y));
  end if;

end Invalid_Value; </lang> Sample output:

X is not valid
X is 1.00000E+00
Y is not valid
Y is GREEN

Note that some types are always initialized valid. E.g. pointers, which are formally non-scalar, are initialized null. Another example are scalar types of which representation does not leave free bit patterns for invalid value. For instance a 32-bit integer will likely valid under any circumstances.

ALGOL 68

Works with: ALGOL 68 version Revision 1 - no extensions to language used
Works with: ALGOL 68G version Any - tested with release 1.18.0-9h.tiny
Works with: ELLA ALGOL 68 version Any (with appropriate job cards) - tested with release 1.8-8d

Note: Some implementations (eg ALGOL 68C) also have a procedure named undefined that is called to indicated that the behaviour at a particular point in a program is unexpected, undefined, or non-standard. <lang algol68>MODE R = REF BOOL; R r := NIL;

MODE U = UNION(BOOL, VOID); U u := EMPTY;

IF r IS R(NIL) THEN

 print(("r IS NIL", new line))

ELSE

 print(("r ISNT NIL", new line))

FI;

CASE u IN

 (VOID):print(("u is EMPTY", new line))
 OUT    print(("u isnt EMPTY", new line))

ESAC</lang> Output:

r IS NIL
u is EMPTY

C

<lang C>

  1. include<stdlib.h>
  2. include<stdio.h>

int main() { int i=NULL;

if(i==NULL) { printf("i is undefined."); }

else { printf("So much for writing code."); }

return 0; } </lang> And the output is: <lang C> i is undefined. </lang>

C#

In C# it's important to see the difference between reference and value types. For reference types (class instances) there is null as a general undefined reference. <lang csharp>string foo = null;</lang> Dereferencing a null reference will throw a NullReferenceException.

This can't be used normally for value types (int, double, DateTime, etc.) since they are no references, so the following is a compiler error: <lang csharp>int i = null;</lang> With .NET 2.0 there is an additional Nullable<T> structure which enables those semantics for value types as well: <lang csharp>int? answer = null; if (answer == null) {

   answer = 42;

}</lang> There is a bit syntactic sugar involved here. The ? after the type name signals the compiler that it's a nullable type. This only works for value types since reference types are nullable due to their very nature.

But since value types still can't actually have a null value this gets converted into the following code by the compiler: <lang csharp>Nullable<int> answer = new Nullable<int>(); if (!answer.HasValue) {

   answer = new Nullable<int>(42);

}</lang> So it's a little compiler magic but in the end works just as one would expect.

Delphi

Delphi and its dialects don't have an undefined notion for all variables, but implement the notion of the keyword nil that is untyped, yet compatible with all pointer types and object references as well as interfaces. No compatibility is given for non-referenced data types like integers, enums and records - as well as string types (Some exceptions exist due to some compiler magic for those types).

For Referenced data types like pointers, classes and interfaces a reference can be explicitely set to undefined by assigning the NIL value for it. No memory management like garbage collection (except for interfaces) is done. <lang delphi>var

   P: PInteger;

begin

   New(P);  //Allocate some memory
   try
       If Assigned(P) Then //...
       begin
           P^ := 42;
       end;
   finally
       Dispose(P); //Release memory allocated by New
   end;

end;</lang>

If P was a Class only the Assigned function would be available; in addition Dispose would have to be replaced by FreeAndNil or calling the .Free method of the instance. For Interfaces no such last call would be necessary as simple removal of the reference would be sufficient to trigger the Garbage Collector.

Go

Go has six types for which nil is defined. Values of these six types can be tested against the predefined identifier nil as shown by task Undefined values/Check if a variable is defined.

For this task, I demonstrate,

  1. How attempts to use nil objects cause panics.
  2. How to initialize objects of these types.
  3. Successful (non panicking) use of initialized objects.
  4. One more quirky little feature involving a type switch on a nil interface.

<lang go>package main

import "fmt"

var (

   s []int
   p *int
   f func()
   i interface{}
   m map[int]int
   c chan int

)

func main() {

   fmt.Println("Exercise nil objects:")
   status()
   // initialize objects
   s = make([]int, 1)
   p = &s[0]    // yes, reference element of slice just created
   f = func() { fmt.Println("function call") }
   i = user(0)  // see user defined type just below
   m = make(map[int]int)
   c = make(chan int, 1)
   fmt.Println("\nExercise objects after initialization:")
   status()

}

type user int

func (user) m() {

   fmt.Println("method call")

}

func status() {

   trySlice()
   tryPointer()
   tryFunction()
   tryInterface()
   tryMap()
   tryChannel()

}

func reportPanic() {

   if x := recover(); x != nil {
       fmt.Println("panic:", x)
   }

}

func trySlice() {

   defer reportPanic()
   fmt.Println("s[0] =", s[0])

}

func tryPointer() {

   defer reportPanic()
   fmt.Println("*p =", *p)

}

func tryFunction() {

   defer reportPanic()
   f()

}

func tryInterface() {

   defer reportPanic()
   // normally the nil identifier accesses a nil value for one of
   // six predefined types.  In a type switch however, nil can be used
   // as a type.  In this case, it matches the nil interface.
   switch i.(type) {
   case nil:
       fmt.Println("i is nil interface")
   case interface{m()}:
       fmt.Println("i has method m")
   }
   // assert type with method and then call method
   i.(interface{m()}).m()

}

func tryMap() {

   defer reportPanic()
   fmt.Println("m[0] =", m[0])

}

func tryChannel() {

   defer reportPanic()
   c <- 0
   fmt.Println("<-c received", <-c)

}</lang> Output:

Exercise nil objects:
panic: runtime error: index out of range
panic: runtime error: invalid memory address or nil pointer dereference
panic: runtime error: invalid memory address or nil pointer dereference
i is nil interface
panic: interface conversion: interface is nil, not interface { m() }
panic: runtime error: invalid memory address or nil pointer dereference
panic: runtime error: send to nil channel

Exercise objects after initialization:
s[0] = 0
*p = 0
function call
i has method m
method call
m[0] = 0
<-c received 0

Haskell

In Haskell, there is a semantic concept called "bottom", which is a computation that never terminates or runs into an error. So undefined is not a proper value at all; it is a bottom that causes an exception when evaluated. For example,

<lang haskell>main = print $ "Incoming error--" ++ undefined -- When run in GHC: -- "Incoming error--*** Exception: Prelude.undefined</lang>

This isn't quite as dangerous as it sounds because of Haskell's laziness. For example, this program:

<lang haskell>main = print $ length [undefined, undefined, 1 `div` 0]</lang>

prints 3, since length doesn't need to evaluate any of the elements of its input.

In practice, one uses undefined less often than error, which behaves exactly the same except that it lets you choose the error message. So if you say

<lang haskell>resurrect 0 = error "I'm out of orange smoke!"</lang>

then if you make the mistake of writing your program such that it at some point requires the value of resurrect 0, you'll get the error message "I'm out of orange smoke!". undefined may be defined in the same way:

<lang haskell>undefined :: a undefined = error "Prelude.undefined"</lang>

Since undefined causes an exception, the usual exception handling mechanism can be used to catch it:

<lang haskell>import Control.Exception (catch, evaluate, ErrorCall) import System.IO.Unsafe (unsafePerformIO) import Prelude hiding (catch) import Control.DeepSeq (NFData, deepseq)

scoopError :: (NFData a) => a -> Either String a scoopError x = unsafePerformIO $ catch right left

 where right = deepseq x $ return $ Right x
       left e = return $ Left $ show (e :: ErrorCall)

safeHead :: (NFData a) => [a] -> Either String a safeHead = scoopError . head

main = do

 print $ safeHead ([] :: String)
 print $ safeHead ["str"]</lang>

Icon and Unicon

Icon/Unicon don't really have a notion of an undefined variable. There is a null value/data type that can be tested. However, it is possible in Unicon to interrogate the environment and obtain the string names of variables in the current (or calling procedures) and determine if a variable is defined.

Icon

The functions localnames, paramnames, staticnames, and globalnames don't exist in Icon.

Unicon

<lang Unicon>global G1

procedure main(arglist) local ML1 static MS1 undeftest() end

procedure undeftest(P1) static S1 local L1,L2 every #write all local, parameter, static, and global variable names

  write((localnames|paramnames|staticnames|globalnames)(&current,0))   # ... visible in the current co-expression at this calling level (0)

return end</lang>

The output looks like:

L1
L2
P1
S1
main
undeftest
write
localnames
paramnames
staticnames
globalnames

Note that ML1,arglist, and MS1 are not listed. Also note, that procedures names are just global variables of type procedure.

J

J does not have a concept of an "undefined value" as such, but J does allow treatment of undefined names. The verb nc finds the (syntactic) class of a name. This result is negative 1 for names which have not been defined.

<lang J>

 foo=: 3
 nc;:'foo bar'

0 _1</lang>

From this we can infer that foo has a definition (and its definition is a noun), and bar does not have a definition.

This task also asked that we identify and exercise .. mechanisms for ... manipulating a variable's value's status as being undefined. So: a name can be made to be undefined using the verb erase. The undefined status can be removed by assigning a value to the name.

<lang J>

  erase;:'foo bar'

1 1

  nc;:'foo bar'

_1 _1

  bar=:99
  nc;:'foo bar'

_1 0</lang>

Java

In Java there are two kinds of types: primitive types and reference types. The former are predefined in the language (eg. boolean, int, long, double, &c), while the latter are pointers to objects (class instances or arrays).

Java has a special null type, the type of the expression null, that can be cast to any reference type; in practice the null type can be ignored and null can be treated as a special literal that can be of any reference type. When a reference variable has the special value null it refers to no object, meaning that it is undefined. <lang java>String string = null; // the variable string is undefined System.out.println(string); //prints "null" to std out System.out.println(string.length()); // dereferencing null throws java.lang.NullPointerException</lang>

Variables of primitive types cannot be assigned the special value null, but there are wrapper classes corresponding to the primitive types (eg. Boolean, Integer, Long, Double, &c), that can be used instead of the corresponding primitive; since they can have the special value null it can be used to identify the variable as undefined. <lang java>int i = null; // compilation error: incompatible types, required: int, found: <nulltype> if (i == null) { // compilation error: incomparable types: int and <nulltype>

   i = 1;

}</lang> But this piece of code can be made valid by replacing int with Integer, and thanks to the automatic conversion between primitive types and their wrapper classes (called autoboxing) the only change required is in the declaration of the variable: <lang java>Integer i = null; // variable i is undefined if (i == null) {

   i = 1;

}</lang>

JavaScript

<lang javascript>var a;

typeof(a) == "undefined"; typeof(b) == "undefined";

var obj = {}; // Empty object. obj.c == null;

obj.c = 42;

obj.c == 42; delete obj.c; obj.c == null;</lang>

Works with: UCB Logo

UCB Logo has separate namespaces for procedures and variables ("names"). There is no distinction between a proc/name with no value and an undefined proc/name.

<lang logo>; procedures to square :x

 output :x * :x

end

show defined? "x  ; true show procedure? "x  ; true (also works for built-in primitives) erase "x show defined? "x  ; false show square 3  ; I don't know how to square

names

make "n 23

show name? "n  ; true ern "n show name? "n  ; false show :n  ; n has no value</lang>

Lua

<lang lua>print( a )

local b print( b )

if b == nil then

   b = 5

end print( b )</lang> Output:

nil
nil
5

MUMPS

MUMPS does have variables with undefined values, but referencing them usually causes an error. To test for whether a value is undefined use the $Data function. If you are trying to read a value that may be undefined, use $Get as a wrapper. Note that an alternate form of $Get can return a specified value, which must be defined.

<lang MUMPS> IF $DATA(SOMEVAR)=0 DO UNDEF ; A result of 0 means the value is undefined

SET LOCAL=$GET(^PATIENT(RECORDNUM,0)) ;If there isn't a defined item at that location, a null string is returned</lang>

OCaml

<lang ocaml>(* There is no undefined value in OCaml,

  but if you really need this you can use the built-in "option" type.
  It is defined like this: type 'a option = None | Some of 'a *)

let inc = function

 Some n -> Some (n+1)

| None -> failwith "Undefined argument";;

inc (Some 0);; (* - : value = Some 1 *)

inc None;; (* Exception: Failure "Undefined argument". *)</lang>

Oz

A program that uses an undefined variable does not compile. However, variables can be "unbound" or "free". If a program tries to read such a variable, the current thread will be suspended until the variable's value becomes determined.

<lang oz>declare X in

thread

  if {IsFree X} then {System.showInfo "X is unbound."} end
  {Wait X}
  {System.showInfo "Now X is determined."}

end

{System.showInfo "Sleeping..."} {Delay 1000} {System.showInfo "Setting X."} X = 42</lang>

Explicitly checking the status of a variable with IsFree is discouraged because it can introduce race conditions.

Perl

<lang perl>#!/usr/bin/perl -w use strict;

  1. Declare the variable. It is initialized to the value "undef"

our $var;

  1. Check to see whether it is defined

print "var contains an undefined value at first check\n" unless defined $var;

  1. Give it a value

$var = "Chocolate";

  1. Check to see whether it is defined after we gave it the
  2. value "Chocolate"

print "var contains an undefined value at second check\n" unless defined $var;

  1. Give the variable the value "undef".

$var = undef;

  1. or, equivalently:

undef($var);

  1. Check to see whether it is defined after we've explicitly
  2. given it an undefined value.

print "var contains an undefined value at third check\n" unless defined $var;

  1. Give the variable a value of 42

$var = 42;

  1. Check to see whether the it is defined after we've given it
  2. the value 42.

print "var contains an undefined value at fourth check\n" unless defined $var;

  1. Because most of the output is conditional, this serves as
  2. a clear indicator that the program has run to completion.

print "Done\n";</lang>

Results in:

var contains an undefined value at first check
var contains an undefined value at third check
Done

PHP

<lang php><?php // Check to see whether it is defined if (!isset($var))

   echo "var is undefined at first check\n";

// Give it a value $var = "Chocolate";

// Check to see whether it is defined after we gave it the // value "Chocolate" if (!isset($var))

   echo "var is undefined at second check\n";

// Give the variable an undefined value. unset($var);

// Check to see whether it is defined after we've explicitly // given it an undefined value. if (!isset($var))

   echo "var is undefined at third check\n";

// Give the variable a value of 42 $var = 42;

// Check to see whether the it is defined after we've given it // the value 42. if (!isset($var))

   echo "var is undefined at fourth check\n";

// Because most of the output is conditional, this serves as // a clear indicator that the program has run to completion. echo "Done\n"; ?></lang>

Results in:

var is undefined at first check
var is undefined at third check
Done

PicoLisp

An internal symbol is initialized to NIL. Depending on the context, this is interpreted as "undefined". When called as a function, an error is issued: <lang PicoLisp>: (myfoo 3 4) !? (myfoo 3 4) myfoo -- Undefined ?</lang> The function 'default' can be used to initialize a variable if and only if its current value is NIL: <lang PicoLisp>: MyVar -> NIL

(default MyVar 7)

-> 7

MyVar

-> 7

(default MyVar 8)

-> 7

MyVar

-> 7</lang>

PureBasic

Variables are defined through a formal declaration or simply upon first use. Each variable is initialized to a value. PureBasic does not allow changing of a variable's status at runtime. It can be tested at compile-time and acted upon, however, it cannot be undefined once it is defined. <lang PureBasic>If OpenConsole()

 CompilerIf Defined(var, #PB_Variable)
   PrintN("var is defined at first check")
 CompilerElse
   PrintN("var is undefined at first check")
   Define var
 CompilerEndIf
 
 CompilerIf Defined(var, #PB_Variable)
   PrintN("var is defined at second check")
 CompilerElse
   PrintN("var is undefined at second check")
   Define var
 CompilerEndIf
 
 Print(#CRLF$ + #CRLF$ + "Press ENTER to exit")
 Input()
 CloseConsole()
 

EndIf</lang> Sample output:

var is undefined at first check
var is defined at second check

Python

In Python names, (variables), can be dynamically created and deleted at run time.

<lang python># Check to see whether a name is defined try: name except NameError: print "name is undefined at first check"

  1. Create a name, giving it a string value

name = "Chocolate"

  1. Check to see whether the name is defined now.

try: name except NameError: print "name is undefined at second check"

  1. Remove the definition of the name.

del name

  1. Check to see whether it is defined after the explicit removal.

try: name except NameError: print "name is undefined at third check"

  1. Recreate the name, giving it a value of 42

name = 42

  1. Check to see whether the name is defined now.

try: name except NameError: print "name is undefined at fourth check"

  1. Because most of the output is conditional, this serves as
  2. a clear indicator that the program has run to completion.

print "Done"</lang>

Results in:

name is undefined at first check
name is undefined at third check
Done

R

There are four cases to consider. To test whether a varaible has previously been defined, use exists. <lang r> exists("x") </lang>

If you want to declare a variable with undefined contents, use NULL. <lang r> x <- NULL </lang>

If you want to declare a variable with missing values, use NA. <lang r> y <- c(1, 4, 9, NA, 25) z <- c("foo", NA, "baz") </lang> (Note that there are different types of NA, namely NA_integer_, NA_real_, NA_character_, NA_complex_ and plain (logical) NA. In practice, you should hardly ever need to explicitly set which type of NA you are using, as it will be done automatically.)

Finally, you test for arguments that haven't been passed into a function with missing. <lang r> print_is_missing <- function(x) {

 print(missing(x))

}

print_is_missing() # TRUE print_is_missing(123) # FALSE </lang>

REXX

<lang rexx> /*REXX program to test if a variable is defined. */

tlaloc = "rain god of the Aztecs."


                   /*check if the rain god is defined.*/

y='tlaloc' if symbol(y)=="VAR" then say y 'is defined.'

                   else say y "ain't defined."


                   /*check if the fire god is defined.*/

y='xiuhtecuhtli' if symbol(y)=="VAR" then say y 'is defined.'

                   else say y "ain't defined."


drop tlaloc /*un-define the TLALOC variable. */

                   /*check if the rain god is defined.*/

y='tlaloc' if symbol(y)=="VAR" then say y 'is defined.'

                   else say y "ain't defined."

</lang> Output:

tlaloc is defined.
xiuhtecuhtli ain't defined.
tlaloc ain't defined.

Ruby

<lang ruby># Check to see whether it is defined puts "var is undefined at first check" unless defined? var

  1. Give it a value

var = "Chocolate"

  1. Check to see whether it is defined after we gave it the
  2. value "Chocolate"

puts "var is undefined at second check" unless defined? var

  1. I don't know any way of undefining a variable in Ruby
  1. Because most of the output is conditional, this serves as
  2. a clear indicator that the program has run to completion.

puts "Done"</lang>

Results in:

var is undefined at first check
Done

Tcl

Tcl does not have undefined values, but variables may be undefined by being not set. <lang tcl># Variables are undefined by default and do not need explicit declaration

  1. Check to see whether it is defined

if {![info exists var]} {puts "var is undefind at first check"}

  1. Give it a value

set var "Screwy Squirrel"

  1. Check to see whether it is defined

if {![info exists var]} {puts "var is undefind at second check"}

  1. Remove its value

unset var

  1. Check to see whether it is defined

if {![info exists var]} {puts "var is undefind at third check"}

  1. Give it a value again

set var 12345

  1. Check to see whether it is defined

if {![info exists var]} {puts "var is undefind at fourth check"}

puts "Done"</lang> Yields this output:

var is undefind at first check
var is undefind at third check
Done

UNIX Shell

<lang bash>VAR1="VAR1" echo ${VAR1:-"Not set."} echo ${VAR2:-"Not set."}</lang>

VAR1
Not set.