about summary refs log blame commit diff stats
path: root/031array.cc
blob: c2cbfd7f47ff4eed8edde0c663d5b8d04d577c64 (plain) (tree)
1
2
3
4
5
6
7
8
9

                                                                              



                                                                               
 

                                               
          

                                                                                   





                                             
                                                  
                                       
                    
                              
                                                                                                                                                        

          
                                        
                                         
                              
                                                                                                                                 

          
                             
                                                                                                                 


                                                                   
                                    
                                                                                                                      

          
                                                      
                                                                                                                                                                                       

          



                                                
                                                         
                                       
                                   
                                                                  
                                                     
                                                                                               
                                                                
                                               
                                                                   
                     
                                               
                                   
   

                              

 
                      
                                                                          
                               



                                                                              
          
                                  


                     
                                         
 



                              
 
                       
          
                                  


                     
                                


                     
                                      
                                                            
                       
                                                                                                             
             
   
                                                            
 
 




                                                                          



                                                                           




                  
                                                     






                                                          
 


                                                    
                                                                                                                                      

               
                                                      
                                                                                                                            

               


   

                                                
                 
          
                                  


                     
                                       
 

                              
                               
          
                                  



                     
                                            
 

                              

                                             
                                        
                                    
                                       
             
                                    
                                                                                                                                      

          
                                        
                               
                           
                                                                                                              

          





                                                                                                                                                 

                                        
                                  
                  
                                                          
                                           
                                                                                                                                                                                                                             

          



                                                
                                                         
                             
                                
                                                                    
                          
                                                                                                                                              

          


                                                          
                                                     

                                                                                                                 

          
                                                                     
                                                              
                                                                                       




                                              


        
       
                                                 



                                     
                     

 








                                                  
                               
                     
          
                                  





                     
                                                                                                           
 
                             
 
                                 
                     
          
                                 





                     
                         
 
                              
 
                                       
                     
          






                                 
                                    
 
                                                                                       
 


                                                                              
          







                                  
                                               
 
                     
          
                                  


                     
                                                   
 
                              

                                             
          
                                        
                                            
                                       


                                                                                                                                          

          
                                        
                                   
                           
                                                                                                                  

          


                                         



                                                                                                                                                                             
                                    
                  


                                                                                                                                                                                                                                                                                                                

          


                                                
                 
                                                         
                                 
                                
                          
                                                                                                                                              

          


                                                          
                                                     

                                                                                                                 

          
                                                                         








                                                                                                            
 
 
                                   
                     
          
                                 





                     

                                                                                                                                             
 
                             
 
                                     
                     
          
                                 





                     

                                                       
 
                              
 


                                   
          
                                  


                     
                                     





                                             
                                      
                                       
              
                                    
                                                                                                                                       

          



                                                                                                 

          



                                                


                                                          
                                                                                                                                              

          
                     
                                                               

        




                                                                             
                                                                     
               
//: Arrays contain a variable number of elements of the same type. Their value
//: starts with the length of the array.
//:
//: You can create arrays of containers, but containers can only contain
//: elements of a fixed size, so you can't create containers containing arrays.
//: Create containers containing addresses to arrays instead.

//: You can create arrays using 'create-array'.
:(scenario create_array)
def main [
  # create an array occupying locations 1 (for the size) and 2-4 (for the elements)
  1:array:number:3 <- create-array
]
+run: creating array of size 4

:(before "End Primitive Recipe Declarations")
CREATE_ARRAY,
:(before "End Primitive Recipe Numbers")
put(Recipe_ordinal, "create-array", CREATE_ARRAY);
:(before "End Primitive Recipe Checks")
case CREATE_ARRAY: {
  if (inst.products.empty()) {
    raise << maybe(get(Recipe, r).name) << "'create-array' needs one product and no ingredients but got '" << to_original_string(inst) << '\n' << end();
    break;
  }
  reagent product = inst.products.at(0);
  // Update CREATE_ARRAY product in Check
  if (!is_mu_array(product)) {
    raise << maybe(get(Recipe, r).name) << "'create-array' cannot create non-array " << product.original_string << '\n' << end();
    break;
  }
  if (!product.type->right) {
    raise << maybe(get(Recipe, r).name) << "create array of what? " << to_original_string(inst) << '\n' << end();
    break;
  }
  // 'create-array' will need to check properties rather than types
  if (!product.type->right->right) {
    raise << maybe(get(Recipe, r).name) << "create array of what size? " << to_original_string(inst) << '\n' << end();
    break;
  }
  if (!is_integer(product.type->right->right->name)) {
    raise << maybe(get(Recipe, r).name) << "'create-array' product should specify size of array after its element type, but got " << product.type->right->right->name << '\n' << end();
    break;
  }
  break;
}
:(before "End Primitive Recipe Implementations")
case CREATE_ARRAY: {
  reagent product = current_instruction().products.at(0);
  // Update CREATE_ARRAY product in Run
  int base_address = product.value;
  int array_length = to_integer(product.type->right->right->name);
  // initialize array size, so that size_of will work
  trace(9999, "mem") << "storing " << array_length << " in location " << base_address << end();
  put(Memory, base_address, array_length);  // in array elements
  int size = size_of(product);  // in locations
  trace(9998, "run") << "creating array of size " << size << end();
  // initialize array
  for (int i = 1; i <= size_of(product); ++i) {
    put(Memory, base_address+i, 0);
  }
  // no need to update product
  goto finish_instruction;
}

:(scenario copy_array)
# Arrays can be copied around with a single instruction just like numbers,
# no matter how large they are.
# You don't need to pass the size around, since each array variable stores its
# size in memory at run-time. We'll call a variable with an explicit size a
# 'static' array, and one without a 'dynamic' array since it can contain
# arrays of many different sizes.
def main [
  1:array:number:3 <- create-array
  2:number <- copy 14
  3:number <- copy 15
  4:number <- copy 16
  5:array:number <- copy 1:array:number:3
]
+mem: storing 3 in location 5
+mem: storing 14 in location 6
+mem: storing 15 in location 7
+mem: storing 16 in location 8

:(scenario stash_array)
def main [
  1:array:number:3 <- create-array
  2:number <- copy 14
  3:number <- copy 15
  4:number <- copy 16
  stash [foo:], 1:array:number:3
]
+app: foo: 3 14 15 16

:(before "End size_of(reagent) Cases")
if (r.type && r.type->value == get(Type_ordinal, "array")) {
  if (!r.type->right) {
    raise << maybe(current_recipe_name()) << "'" << r.original_string << "' is an array of what?\n" << end();
    return 1;
  }
  return 1 + array_length(r)*size_of(array_element(r.type));
}

//: disable the size mismatch check for arrays since the destination array
//: need not be initialized
:(before "End size_mismatch(x) Cases")
if (x.type && x.type->value == get(Type_ordinal, "array")) return false;

//: arrays are disallowed inside containers unless their length is fixed in
//: advance

:(scenario container_contains_array)
container foo [
  x:array:number:3
]
$error: 0

:(scenario container_disallows_dynamic_array_element)
% Hide_errors = true;
container foo [
  x:array:number
]
+error: container 'foo' cannot determine size of element x

:(before "End Load Container Element Definition")
{
  const type_tree* type = info.elements.back().type;
  if (type->name == "array") {
    if (!type->right) {
      raise << "container '" << name << "' doesn't specify type of array elements for " << info.elements.back().name << '\n' << end();
      continue;
    }
    if (!type->right->right) {  // array has no length
      raise << "container '" << name << "' cannot determine size of element " << info.elements.back().name << '\n' << end();
      continue;
    }
  }
}

//:: To access elements of an array, use 'index'

:(scenario index)
def main [
  1:array:number:3 <- create-array
  2:number <- copy 14
  3:number <- copy 15
  4:number <- copy 16
  5:number <- index 1:array:number:3, 0
]
+mem: storing 14 in location 5

:(scenario index_direct_offset)
def main [
  1:array:number:3 <- create-array
  2:number <- copy 14
  3:number <- copy 15
  4:number <- copy 16
  5:number <- copy 0
  6:number <- index 1:array:number, 5:number
]
+mem: storing 14 in location 6

:(before "End Primitive Recipe Declarations")
INDEX,
:(before "End Primitive Recipe Numbers")
put(Recipe_ordinal, "index", INDEX);
:(before "End Primitive Recipe Checks")
case INDEX: {
  if (SIZE(inst.ingredients) != 2) {
    raise << maybe(get(Recipe, r).name) << "'index' expects exactly 2 ingredients in '" << to_original_string(inst) << "'\n" << end();
    break;
  }
  reagent base = inst.ingredients.at(0);
  // Update INDEX base in Check
  if (!is_mu_array(base)) {
    raise << maybe(get(Recipe, r).name) << "'index' on a non-array " << base.original_string << '\n' << end();
    break;
  }
  reagent index = inst.ingredients.at(1);
  // Update INDEX index in Check
  if (!is_mu_number(index)) {
    raise << maybe(get(Recipe, r).name) << "second ingredient of 'index' should be a number, but got " << index.original_string << '\n' << end();
    break;
  }
  if (inst.products.empty()) break;
  reagent product = inst.products.at(0);
  // Update INDEX product in Check
  reagent element;
  element.type = new type_tree(*array_element(base.type));
  if (!types_coercible(product, element)) {
    raise << maybe(get(Recipe, r).name) << "'index' on " << base.original_string << " can't be saved in " << product.original_string << "; type should be " << names_to_string_without_quotes(element.type) << '\n' << end();
    break;
  }
  break;
}
:(before "End Primitive Recipe Implementations")
case INDEX: {
  reagent base = current_instruction().ingredients.at(0);
  // Update INDEX base in Run
  int base_address = base.value;
  trace(9998, "run") << "base address is " << base_address << end();
  if (base_address == 0) {
    raise << maybe(current_recipe_name()) << "tried to access location 0 in '" << to_original_string(current_instruction()) << "'\n" << end();
    break;
  }
  reagent index = current_instruction().ingredients.at(1);
  // Update INDEX index in Run
  vector<double> index_val(read_memory(index));
  type_tree* element_type = array_element(base.type);
  if (index_val.at(0) < 0 || index_val.at(0) >= get_or_insert(Memory, base_address)) {
    raise << maybe(current_recipe_name()) << "invalid index " << no_scientific(index_val.at(0)) << '\n' << end();
    break;
  }
  int src = base_address + 1 + index_val.at(0)*size_of(element_type);
  trace(9998, "run") << "address to copy is " << src << end();
  trace(9998, "run") << "its type is " << get(Type, element_type->value).name << end();
  reagent element;
  element.set_value(src);
  element.type = new type_tree(*element_type);
  // Read element
  products.push_back(read_memory(element));
  break;
}

:(code)
type_tree* array_element(const type_tree* type) {
  if (type->right->left) {
    assert(!type->right->left->left);
    return type->right->left;
  }
  return type->right;
}

int array_length(const reagent& x) {
  if (x.type->right->right) {
    return to_integer(x.type->right->right->name);
  }
  // this should never happen at transform time
  // x should already be canonized.
  return get_or_insert(Memory, x.value);
}

:(scenario index_out_of_bounds)
% Hide_errors = true;
def main [
  1:array:number:3 <- create-array
  2:number <- copy 14
  3:number <- copy 15
  4:number <- copy 16
  5:number <- copy 14
  6:number <- copy 15
  7:number <- copy 16
  index 1:array:number:3, 4  # less than size of array in locations, but larger than its length in elements
]
+error: main: invalid index 4

:(scenario index_out_of_bounds_2)
% Hide_errors = true;
def main [
  1:array:point:3 <- create-array
  2:number <- copy 14
  3:number <- copy 15
  4:number <- copy 16
  5:number <- copy 14
  6:number <- copy 15
  7:number <- copy 16
  index 1:array:point, -1
]
+error: main: invalid index -1

:(scenario index_product_type_mismatch)
% Hide_errors = true;
def main [
  1:array:point:3 <- create-array
  2:number <- copy 14
  3:number <- copy 15
  4:number <- copy 16
  5:number <- copy 14
  6:number <- copy 15
  7:number <- copy 16
  9:number <- index 1:array:point, 0
]
+error: main: 'index' on 1:array:point can't be saved in 9:number; type should be point

//: we might want to call 'index' without saving the results, say in a sandbox

:(scenario index_without_product)
def main [
  1:array:number:3 <- create-array
  2:number <- copy 14
  3:number <- copy 15
  4:number <- copy 16
  index 1:array:number:3, 0
]
# just don't die

//:: To write to elements of arrays, use 'put'.

:(scenario put_index)
def main [
  1:array:number:3 <- create-array
  2:number <- copy 14
  3:number <- copy 15
  4:number <- copy 16
  1:array:number <- put-index 1:array:number, 1, 34
]
+mem: storing 34 in location 3

:(before "End Primitive Recipe Declarations")
PUT_INDEX,
:(before "End Primitive Recipe Numbers")
put(Recipe_ordinal, "put-index", PUT_INDEX);
:(before "End Primitive Recipe Checks")
case PUT_INDEX: {
  if (SIZE(inst.ingredients) != 3) {
    raise << maybe(get(Recipe, r).name) << "'put-index' expects exactly 3 ingredients in '" << to_original_string(inst) << "'\n" << end();
    break;
  }
  reagent base = inst.ingredients.at(0);
  // Update PUT_INDEX base in Check
  if (!is_mu_array(base)) {
    raise << maybe(get(Recipe, r).name) << "'put-index' on a non-array " << base.original_string << '\n' << end();
    break;
  }
  reagent index = inst.ingredients.at(1);
  // Update PUT_INDEX index in Check
  if (!is_mu_number(index)) {
    raise << maybe(get(Recipe, r).name) << "second ingredient of 'put-index' should have type 'number', but got " << inst.ingredients.at(1).original_string << '\n' << end();
    break;
  }
  reagent value = inst.ingredients.at(2);
  // Update PUT_INDEX value in Check
  reagent element;
  element.type = new type_tree(*array_element(base.type));
  if (!types_coercible(element, value)) {
    raise << maybe(get(Recipe, r).name) << "'put-index " << base.original_string << ", " << inst.ingredients.at(1).original_string << "' should store " << names_to_string_without_quotes(element.type) << " but " << value.name << " has type " << names_to_string_without_quotes(value.type) << '\n' << end();
    break;
  }
  break;
}
:(before "End Primitive Recipe Implementations")
case PUT_INDEX: {
  reagent base = current_instruction().ingredients.at(0);
  // Update PUT_INDEX base in Run
  int base_address = base.value;
  if (base_address == 0) {
    raise << maybe(current_recipe_name()) << "tried to access location 0 in '" << to_original_string(current_instruction()) << "'\n" << end();
    break;
  }
  reagent index = current_instruction().ingredients.at(1);
  // Update PUT_INDEX index in Run
  vector<double> index_val(read_memory(index));
  type_tree* element_type = array_element(base.type);
  if (index_val.at(0) < 0 || index_val.at(0) >= get_or_insert(Memory, base_address)) {
    raise << maybe(current_recipe_name()) << "invalid index " << no_scientific(index_val.at(0)) << '\n' << end();
    break;
  }
  int address = base_address + 1 + index_val.at(0)*size_of(element_type);
  trace(9998, "run") << "address to copy to is " << address << end();
  // optimization: directly write the element rather than updating 'product'
  // and writing the entire array
  vector<double> value = read_memory(current_instruction().ingredients.at(2));
  for (int i = 0; i < SIZE(value); ++i) {
    trace(9999, "mem") << "storing " << no_scientific(value.at(i)) << " in location " << address+i << end();
    put(Memory, address+i, value.at(i));
  }
  goto finish_instruction;
}

:(scenario put_index_out_of_bounds)
% Hide_errors = true;
def main [
  1:array:point:3 <- create-array
  2:number <- copy 14
  3:number <- copy 15
  4:number <- copy 16
  5:number <- copy 14
  6:number <- copy 15
  7:number <- copy 16
  8:point <- merge 34, 35
  1:array:point <- put-index 1:array:point, 4, 8:point  # '4' is less than size of array in locations, but larger than its length in elements
]
+error: main: invalid index 4

:(scenario put_index_out_of_bounds_2)
% Hide_errors = true;
def main [
  1:array:point:3 <- create-array
  2:number <- copy 14
  3:number <- copy 15
  4:number <- copy 16
  5:number <- copy 14
  6:number <- copy 15
  7:number <- copy 16
  8:point <- merge 34, 35
  1:array:point <- put-index 1:array:point, -1, 8:point
]
+error: main: invalid index -1

//:: compute the length of an array

:(scenario array_length)
def main [
  1:array:number:3 <- create-array
  2:number <- copy 14
  3:number <- copy 15
  4:number <- copy 16
  5:number <- length 1:array:number:3
]
+mem: storing 3 in location 5

:(before "End Primitive Recipe Declarations")
LENGTH,
:(before "End Primitive Recipe Numbers")
put(Recipe_ordinal, "length", LENGTH);
:(before "End Primitive Recipe Checks")
case LENGTH: {
  if (SIZE(inst.ingredients) != 1) {
    raise << maybe(get(Recipe, r).name) << "'length' expects exactly 2 ingredients in '" << to_original_string(inst) << "'\n" << end();
    break;
  }
  reagent array = inst.ingredients.at(0);
  // Update LENGTH array in Check
  if (!is_mu_array(array)) {
    raise << "tried to calculate length of non-array " << array.original_string << '\n' << end();
    break;
  }
  break;
}
:(before "End Primitive Recipe Implementations")
case LENGTH: {
  reagent array = current_instruction().ingredients.at(0);
  // Update LENGTH array in Run
  if (array.value == 0) {
    raise << maybe(current_recipe_name()) << "tried to access location 0 in '" << to_original_string(current_instruction()) << "'\n" << end();
    break;
  }
  products.resize(1);
  products.at(0).push_back(get_or_insert(Memory, array.value));
  break;
}

//: optimization: none of the instructions in this layer use 'ingredients' so
//: stop copying potentially huge arrays into it.
:(before "End should_copy_ingredients Special-cases")
recipe_ordinal r = current_instruction().operation;
if (r == CREATE_ARRAY || r == INDEX || r == PUT_INDEX || r == LENGTH)
  return false;