src/metrics/metrics_base.nit

   1 # This file is part of NIT ( http://www.nitlanguage.org ).
   2 #
   3 # Copyright 2012 Jean Privat <jean@pryen.org>
   4 #
   5 # Licensed under the Apache License, Version 2.0 (the "License");
   6 # you may not use this file except in compliance with the License.
   7 # You may obtain a copy of the License at
   8 #
   9 #     http://www.apache.org/licenses/LICENSE-2.0
  10 #
  11 # Unless required by applicable law or agreed to in writing, software
  12 # distributed under the License is distributed on an "AS IS" BASIS,
  13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 # See the License for the specific language governing permissions and
  15 # limitations under the License.
  16
  17 # Helpers for various statistics tools.
  18 module metrics_base
  19
  20 import modelbuilder
  21
  22 redef class ToolContext
  23
  24         # --generate_hyperdoc
  25         var opt_generate_hyperdoc = new OptionBool("Generate Hyperdoc", "--generate_hyperdoc")
  26
  27         var opt_dir = new OptionString("Directory where some statistics files are generated", "-d", "--dir")
  28         var output_dir: String = "."
  29
  30         redef init
  31         do
  32                 super
  33                 self.option_context.add_option(opt_generate_hyperdoc)
  34                 self.option_context.add_option(opt_dir)
  35         end
  36
  37         redef fun process_options
  38         do
  39                 super
  40                 var val = self.opt_dir.value
  41                 if val != null then
  42                         val = val.simplify_path
  43                         val.mkdir
  44                         self.output_dir = val
  45                 end
  46         end
  47 end
  48
  49 # A counter counts occurence of things
  50 # Use this instead of a HashMap[E, Int]
  51 class Counter[E: Object]
  52         # Total number of counted occurences
  53         var total: Int = 0
  54
  55         private var map = new HashMap[E, Int]
  56
  57         # The number of counted occurences of `e'
  58         fun [](e: E): Int
  59         do
  60                 var map = self.map
  61                 if map.has_key(e) then return map[e]
  62                 return 0
  63         end
  64
  65         # Count one more occurence of `e'
  66         fun inc(e: E)
  67         do
  68                 self.map[e] = self[e] + 1
  69                 total += 1
  70         end
  71
  72         # Return an array of elements sorted by occurences
  73         fun sort: Array[E]
  74         do
  75                 var res = map.keys.to_a
  76                 var sorter = new CounterSorter[E](self)
  77                 sorter.sort(res)
  78                 #res.sort !cmp a, b = map[a] <=> map[b]
  79                 return res
  80         end
  81 end
  82
  83 private class CounterSorter[E: Object]
  84         super AbstractSorter[E]
  85         var counter: Counter[E]
  86         redef fun compare(a,b) do return self.counter.map[a] <=> self.counter.map[b]
  87 end
  88
  89 # Helper function to display n/d and handle division by 0
  90 fun div(n: Int, d: Int): String
  91 do
  92         if d == 0 then return "na"
  93         return ((100*n/d).to_f/100.0).to_precision(2)
  94 end