Add parameter-indices to util Makefile

Author: smowton

src/util/Makefile

@@ -22,7 +22,7 @@ SRC = arith_tools.cpp base_type.cpp cmdline.cpp config.cpp symbol_table.cpp \
       irep_ids.cpp byte_operators.cpp string2int.cpp file_util.cpp \
       memory_info.cpp pipe_stream.cpp irep_hash.cpp endianness_map.cpp \
       ssa_expr.cpp json_irep.cpp json_expr.cpp \
-      string_utils.cpp
+      string_utils.cpp parameter_indices.cpp
 
 INCLUDES= -I ..
 

src/util/parameter_indices.cpp

@@ -1,10 +1,30 @@
+/*******************************************************************\
+
+Module: Parameter indexing
+
+Author: Chris Smowton, [email protected]
+
+\*******************************************************************/
 
 #include "parameter_indices.h"
 
-std::map<irep_idt,std::size_t> get_parameter_indices(const code_typet& fn_type)
+/*******************************************************************\
+
+Function: get_parameter_indices
+
+  Inputs: Code type
+
+ Outputs: Map from parameter name to position
+
+ Purpose: Make a map useful for mapping from symbol expressions to
+          actual or formal parameter indices.
+
+\*******************************************************************/
+
+std::map<irep_idt, std::size_t> get_parameter_indices(const code_typet &fn_type)
 {
-  std::map<irep_idt,std::size_t>  parameter_indices;
-  for (std::size_t  i = 0UL; i != fn_type.parameters().size(); ++i)
-    parameter_indices.insert({fn_type.parameters().at(i).get_identifier(),i});
+  std::map<irep_idt, std::size_t>  parameter_indices;
+  for(std::size_t i=0; i!=fn_type.parameters().size(); ++i)
+    parameter_indices.insert({fn_type.parameters().at(i).get_identifier(), i});
   return parameter_indices;
 }

src/util/parameter_indices.h

@@ -1,9 +1,18 @@
-#ifndef PARAMETER_INDICES_H
-#define PARAMETER_INDICES_H
+/*******************************************************************\
+
+Module: Parameter indexing
+
+Author: Chris Smowton, [email protected]
+
+\*******************************************************************/
+
+#ifndef CPROVER_UTIL_PARAMETER_INDICES_H
+#define CPROVER_UTIL_PARAMETER_INDICES_H
 
 #include <unordered_map>
 #include "std_types.h"
 
-std::map<irep_idt,std::size_t> get_parameter_indices(const code_typet& fn_type);
+std::map<irep_idt, std::size_t>
+  get_parameter_indices(const code_typet &fn_type);
 
 #endif