From c7a559a39ef5ca843323c51b92051819b26c85d1 Mon Sep 17 00:00:00 2001
From: Olivier Sauter <olivier.sauter@epfl.ch>
Date: Thu, 6 Apr 2017 15:41:34 +0000
Subject: [PATCH] add comments

git-svn-id: https://spcsvn.epfl.ch/repos/TCV/gdat/trunk@7241 d63d8f72-b253-0410-a779-e742ad2e26cf
---
 crpptbx/iround_os.m | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/crpptbx/iround_os.m b/crpptbx/iround_os.m
index 92905ffb..c9680680 100644
--- a/crpptbx/iround_os.m
+++ b/crpptbx/iround_os.m
@@ -1,12 +1,13 @@
 function  [is,sigi]=iround_os(sig,val)
+%
 % Given two arrays sig and val, for each element in val 
 % returns the index and value of the nearest element in sig.
 % 
-% sig and/or val can be non-monotonic
+% sig and/or val can be non-monotonic (contrary to TCV iround which requires sig to be monotonic)
 %
 % Example:
 %
-% >> [i,sigi]=iround_OS(sig,val);
+% >> [i,sigi]=iround_os(sig,val);
 %
 %
 %
-- 
GitLab