8a8aa6699d270b1f68554f4261525a5dbc4f1f19
[moodle.git] / analytics / classes / local / indicator / discrete.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Abstract discrete indicator.
19  *
20  * @package   core_analytics
21  * @copyright 2017 David Monllao {@link http://www.davidmonllao.com}
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace core_analytics\local\indicator;
27 defined('MOODLE_INTERNAL') || die();
29 /**
30  * Abstract discrete indicator.
31  *
32  * @package   core_analytics
33  * @copyright 2017 David Monllao {@link http://www.davidmonllao.com}
34  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
35  */
36 abstract class discrete extends base {
38     /**
39      * Classes need to be defined so they can be converted internally to individual dataset features.
40      *
41      * @return string[]
42      */
43     protected static function get_classes() {
44         throw new \coding_exception('Please overwrite get_classes() specifying your discrete-values\' indicator classes');
45     }
47     /**
48      * Returns 1 feature header for each of the classes.
49      *
50      * @return string[]
51      */
52     public static function get_feature_headers() {
53         $fullclassname = '\\' . get_called_class();
55         $headers = array($fullclassname);
56         foreach (self::get_classes() as $class) {
57             $headers[] = $fullclassname . '/' . $class;
58         }
60         return $headers;
61     }
63     /**
64      * Whether the value should be displayed or not.
65      *
66      * @param float $value
67      * @param string $subtype
68      * @return bool
69      */
70     public function should_be_displayed($value, $subtype) {
71         if ($value != static::get_max_value()) {
72             // Discrete values indicators are converted internally to 1 feature per indicator, we are only interested
73             // in showing the feature flagged with the max value.
74             return false;
75         }
76         return true;
77     }
79     /**
80      * Returns the value to display when the prediction is $value.
81      *
82      * @param float $value
83      * @param string $subtype
84      * @return string
85      */
86     public function get_display_value($value, $subtype = false) {
88         $displayvalue = array_search($subtype, static::get_classes(), false);
90         debugging('Please overwrite \core_analytics\local\indicator\discrete::get_display_value to show something ' .
91             'different than the default "' . $displayvalue . '"', DEBUG_DEVELOPER);
93         return $displayvalue;
94     }
96     /**
97      * get_display_style
98      *
99      * @param float $ignoredvalue
100      * @param string $ignoredsubtype
101      * @return int
102      */
103     public function get_display_style($ignoredvalue, $ignoredsubtype) {
104         // No style attached to indicators classes, they are what they are, a cat,
105         // a horse or a sandwich, they are not good or bad.
106         return \core_analytics\calculable::OUTCOME_NEUTRAL;
107     }
109     /**
110      * From calculated values to dataset features.
111      *
112      * One column for each class.
113      *
114      * @param float[] $calculatedvalues
115      * @return float[]
116      */
117     protected function to_features($calculatedvalues) {
119         $classes = self::get_classes();
121         foreach ($calculatedvalues as $sampleid => $calculatedvalue) {
123             $classindex = array_search($calculatedvalue, $classes, true);
125             if (!$classindex) {
126                 throw new \coding_exception(get_class($this) . ' calculated "' . $calculatedvalue .
127                     '" which is not one of its defined classes (' . json_encode($classes) . ')');
128             }
130             // We transform the calculated value into multiple features, one for each of the possible classes.
131             $features = array_fill(0, count($classes), 0);
133             // 1 to the selected value.
134             $features[$classindex] = 1;
136             $calculatedvalues[$sampleid] = $features;
137         }
139         return $calculatedvalues;
140     }