Merge pull request #79 from cpp-lln-lab/remi-update_randomize

add functions for randomizations with their tests

Author: Remi-Gau

README.md

@@ -1,7 +1,7 @@
 [![](https://img.shields.io/badge/Octave-CI-blue?logo=Octave&logoColor=white)](https://github.com/cpp-lln-lab/CPP_PTB/actions)
 ![](https://github.com/cpp-lln-lab/CPP_PTB/workflows/CI/badge.svg) 
 
-[![Build Status](https://travis-ci.com/cpp-lln-lab/CPP_BIDS.svg?branch=master)](https://travis-ci.com/cpp-lln-lab/CPP_PTB)
+[![Build Status](https://travis-ci.com/cpp-lln-lab/CPP_PTB.svg?branch=master)](https://travis-ci.com/cpp-lln-lab/CPP_PTB)
 
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
 [![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)

manualTests/miss_hit.cfg

@@ -0,0 +1,10 @@
+# style guide (https://florianschanda.github.io/miss_hit/style_checker.html)
+line_length: 100
+regex_function_name: "((test_[a-z]+)|[a-z]+)(([A-Z]){1}[A-Za-z]+)*"
+suppress_rule: "copyright_notice"
+
+# metrics limit for the code quality (https://florianschanda.github.io/miss_hit/metrics.html)
+metric "cnest": limit 4
+metric "file_length": limit 500
+metric "cyc": limit 15
+metric "parameters": limit 5

tests/manualTests/test_getResponse.m renamed to manualTests/test_getResponse.m

@@ -1,4 +1,4 @@
-# styly guide (https://florianschanda.github.io/miss_hit/style_checker.html)
+# style guide (https://florianschanda.github.io/miss_hit/style_checker.html)
 line_length: 100
 regex_function_name: "[a-z]+(([A-Z]){1}[A-Za-z]+)*"
 suppress_rule: "copyright_notice"

miss_hit.cfg

@@ -0,0 +1,10 @@
+function retval = isOctave
+    % Return: true if the environment is Octave.
+    persistent cacheval   % speeds up repeated calls
+
+    if isempty (cacheval)
+        cacheval = (exist ('OCTAVE_VERSION', 'builtin') > 0);
+    end
+
+    retval = cacheval;
+end

src/isOctave.m

@@ -0,0 +1,33 @@
+function shuffledRepeats = repeatShuffleConditions(baseConditionVector, nbRepeats)
+    % shuffledRepeats = repeatShuffleConditions(baseConditionVector, nbRepeats)
+    %
+    % given baseConditionVector, a vector of conditions (coded as numbers), this will
+    % create a longer vector made of nbRepeats of this base vector and makesure
+    % that a given condition is not repeated one after the other
+
+    % TODO
+    % - needs some input checks to make sure that there is actually a solution
+    % for this randomization (e.g having [1 1 1 1 1 2] as input will lead to an
+    % infinite loop)
+
+    if numel(unique(baseConditionVector)) == 1
+        error('There should be more than one condition to shuffle');
+    end
+
+    baseConditionVector = baseConditionVector(:)';
+
+    while 1
+        tmp = [];
+        for iRepeat = 1:nbRepeats
+
+            tmp = [tmp, shuffle(baseConditionVector)];
+
+        end
+        if ~any(diff(tmp, [], 2) == 0)
+            break
+        end
+    end
+
+    shuffledRepeats = tmp;
+
+end

src/randomization/repeatShuffleConditions.m

@@ -0,0 +1,33 @@
+function chosenPositions = setTargetPositionInSequence(seqLength, nbTarget, forbiddenPos)
+    % chosenPositions = setTargetPositionInSequence(seqLength, nbTarget, forbiddenPos)
+    %
+    % For a sequence of length seqLength where we want to insert nbTarget targets, this
+    % will return nbTarget random position in that sequence and make sure that,
+    % they are not consecutive positions.
+
+    REPLACE = false;
+
+    allowedPositions = setxor(forbiddenPos, 1:seqLength);
+
+    chosenPositions = [];
+
+    if nbTarget < 1
+        return
+
+    elseif nbTarget == 1
+
+        chosenPositions = randsample(allowedPositions, nbTarget, REPLACE);
+
+    else
+
+        targetDifference = 0;
+
+        while any(abs(targetDifference) < 2)
+            chosenPositions = randsample(allowedPositions, nbTarget, REPLACE);
+            chosenPositions = sort(chosenPositions);
+            targetDifference = diff(chosenPositions, [], 2);
+        end
+
+    end
+
+end

src/randomization/setTargetPositionInSequence.m

@@ -0,0 +1,11 @@
+function shuffled = shuffle(unshuffled)
+    % in case PTB is not in the path
+    % mostly for unit test
+    %
+
+    try
+        shuffled = Shuffle(unshuffled);
+    catch
+        shuffled = unshuffled(randperm(length(unshuffled)));
+    end
+end

src/randomization/shuffle.m

@@ -1,3 +1,10 @@
+# style guide (https://florianschanda.github.io/miss_hit/style_checker.html)
 line_length: 100
 regex_function_name: "((test_[a-z]+)|[a-z]+)(([A-Z]){1}[A-Za-z]+)*"
-suppress_rule: "copyright_notice"
+suppress_rule: "copyright_notice"
+
+# metrics limit for the code quality (https://florianschanda.github.io/miss_hit/metrics.html)
+metric "cnest": limit 4
+metric "file_length": limit 500
+metric "cyc": limit 15
+metric "parameters": limit 5