boost/python/slice.hpp: correct long-standing spelling error; affects interface; keeping old interface for backward compatibility

Ralf W. Grosse-Kunstleve · Ralf W. Grosse-Kunstleve · commit 3e409f9a87bf · 2011-06-14T23:23:33.000Z
[SVN r72602]
diff --git a/doc/v2/slice.html b/doc/v2/slice.html
@@ -85,7 +85,7 @@ <h4><a name="slice-spec-synopsis"></a>Class <code>slice</code> synopsis</h4>
       object stop();
       object step();
 
-      // The return type of slice::get_indicies()
+      // The return type of slice::get_indices()
       template &lt;typename RandomAccessIterator&gt;
       struct range
       {
@@ -96,7 +96,7 @@ <h4><a name="slice-spec-synopsis"></a>Class <code>slice</code> synopsis</h4>
 
       template &lt;typename RandomAccessIterator&gt;
       range&lt;RandomAccessIterator&gt;
-      get_indicies(
+      get_indices(
           RandomAccessIterator const&amp; begin, 
           RandomAccessIterator const&amp; end);
   };
@@ -164,7 +164,7 @@ <h4><a name="slice-spec-observers"></a>Class <code>slice</code>
 <pre>
 template &lt;typename RandomAccessIterator&gt;
 slice::range&lt;RandomAccessIterator&gt;
-slice::get_indicies( 
+slice::get_indices( 
     RandomAccessIterator const&amp; begin, 
     RandomAccessIterator const&amp; end) const;
 </pre>
@@ -173,16 +173,16 @@ <h4><a name="slice-spec-observers"></a>Class <code>slice</code>
 Iterators that form a half-open range.</dt>
   <dt><b>Effects:</b> Create a RandomAccessIterator pair that defines a
 fully-closed range within the [begin,end) range of its arguments.&nbsp;
-This function translates this slice's indicies while accounting for the
-effects of any PyNone or negative indicies, and non-singular step sizes.</dt>
+This function translates this slice's indices while accounting for the
+effects of any PyNone or negative indices, and non-singular step sizes.</dt>
   <dt><b>Returns:</b> a slice::range
 that has been initialized with a non-zero value of step and a pair of
 RandomAccessIterators that point within the range of this functions
 arguments and define a closed interval.</dt>
   <dt><b>Throws:</b> <a href="definitions.html#raise">Raises</a> a Python <code>TypeError</code> exception if any of this slice's arguments
 are neither references to <code>PyNone</code> nor convertible to <code>int</code>.&nbsp; Throws
 <code>std::invalid_argument</code> if the resulting range would be empty.&nbsp; You
-should always wrap calls to <code>slice::get_indicies()</code>
+should always wrap calls to <code>slice::get_indices()</code>
 within <code>try { ...; } catch (std::invalid_argument) {}</code> to
 handle this case and take appropriate action.</dt>
   <dt><b>Rationale</b>: closed-interval: If
@@ -221,7 +221,7 @@ <h2><a name="examples"></a><b>Examples</b></h2>
 {
     slice::range&lt;std::vector&lt;double&gt;::const_iterator&gt; bounds;
     try {
-        bounds = index.get_indicies&lt;&gt;(Foo.begin(), Foo.end());
+        bounds = index.get_indices&lt;&gt;(Foo.begin(), Foo.end());
     }
     catch (std::invalid_argument) {
         return 0.0;
diff --git a/include/boost/python/slice.hpp b/include/boost/python/slice.hpp
@@ -30,7 +30,7 @@ namespace detail
       // that created this slice, than that parameter is None here, and compares 
       // equal to a default-constructed boost::python::object.
       // If a user-defined type wishes to support slicing, then support for the 
-      // special meaning associated with negative indicies is up to the user.
+      // special meaning associated with negative indices is up to the user.
       object start() const;
       object stop() const;
       object step() const;
@@ -63,7 +63,7 @@ class slice : public detail::slice_base
         
     // The following algorithm is intended to automate the process of 
     // determining a slice range when you want to fully support negative
-    // indicies and non-singular step sizes.  Its functionallity is simmilar to 
+    // indices and non-singular step sizes.  Its functionallity is simmilar to 
     // PySlice_GetIndicesEx() in the Python/C API, but tailored for C++ users.
     // This template returns a slice::range struct that, when used in the 
     // following iterative loop, will traverse a slice of the function's
@@ -110,7 +110,7 @@ class slice : public detail::slice_base
     
     template<typename RandomAccessIterator>
     slice::range<RandomAccessIterator>
-    get_indicies( const RandomAccessIterator& begin, 
+    get_indices( const RandomAccessIterator& begin, 
         const RandomAccessIterator& end) const
     {
         // This is based loosely on PySlice_GetIndicesEx(), but it has been 
@@ -240,6 +240,16 @@ class slice : public detail::slice_base
         
         return ret;
     }
+
+    // Incorrect spelling. DO NOT USE. Only here for backward compatibility.
+    // Corrected 2011-06-14.
+    template<typename RandomAccessIterator>
+    slice::range<RandomAccessIterator>
+    get_indicies( const RandomAccessIterator& begin, 
+        const RandomAccessIterator& end) const
+    {
+        get_indices(begin, end);
+    }
         
  public:
     // This declaration, in conjunction with the specialization of 
diff --git a/test/slice.cpp b/test/slice.cpp
@@ -98,9 +98,9 @@ bool accept_slice( slice) { return true; }
 
 #if BOOST_WORKAROUND( BOOST_MSVC, BOOST_TESTED_AT(1400)) \
     || BOOST_WORKAROUND( BOOST_INTEL_WIN, == 710)
-int check_slice_get_indicies(slice index);
+int check_slice_get_indices(slice index);
 #endif
-int check_slice_get_indicies(
+int check_slice_get_indices(
 #if !BOOST_WORKAROUND(__SUNPRO_CC, BOOST_TESTED_AT(0x590))
     const
 #endif 
@@ -116,7 +116,7 @@ int check_slice_get_indicies(
     
     slice::range<std::vector<int>::iterator> bounds;
     try {
-        bounds = index.get_indicies(coll.begin(), coll.end());
+        bounds = index.get_indices(coll.begin(), coll.end());
     }
     catch (std::invalid_argument) {
         return 0;
@@ -136,5 +136,5 @@ BOOST_PYTHON_MODULE(slice_ext)
     def( "accept_slice", accept_slice);
     def( "check_numeric_array_rich_slice", check_numeric_array_rich_slice);
     def( "check_string_rich_slice", check_string_rich_slice);
-    def( "check_slice_get_indicies", check_slice_get_indicies);
+    def( "check_slice_get_indices", check_slice_get_indices);
 }
diff --git a/test/slice.py b/test/slice.py
@@ -37,17 +37,17 @@
 ...     print 1
 ...
 1
->>> check_slice_get_indicies( slice(None))
+>>> check_slice_get_indices( slice(None))
 0
->>> check_slice_get_indicies( slice(2,-2))
+>>> check_slice_get_indices( slice(2,-2))
 0
->>> check_slice_get_indicies( slice(2, None, 2))
+>>> check_slice_get_indices( slice(2, None, 2))
 5
->>> check_slice_get_indicies( slice(2, None, -1))
+>>> check_slice_get_indices( slice(2, None, -1))
 -12
->>> check_slice_get_indicies( slice( 20, None))
+>>> check_slice_get_indices( slice( 20, None))
 0
->>> check_slice_get_indicies( slice( -2, -5, -2))
+>>> check_slice_get_indices( slice( -2, -5, -2))
 6
 """
 

Original file line number	Diff line number	Diff line change
`@@ -37,17 +37,17 @@`
`37`	`37`	`... print 1`
`38`	`38`	`...`
`39`	`39`	`1`
`40`		`->>> check_slice_get_indicies( slice(None))`
	`40`	`+>>> check_slice_get_indices( slice(None))`
`41`	`41`	`0`
`42`		`->>> check_slice_get_indicies( slice(2,-2))`
	`42`	`+>>> check_slice_get_indices( slice(2,-2))`
`43`	`43`	`0`
`44`		`->>> check_slice_get_indicies( slice(2, None, 2))`
	`44`	`+>>> check_slice_get_indices( slice(2, None, 2))`
`45`	`45`	`5`
`46`		`->>> check_slice_get_indicies( slice(2, None, -1))`
	`46`	`+>>> check_slice_get_indices( slice(2, None, -1))`
`47`	`47`	`-12`
`48`		`->>> check_slice_get_indicies( slice( 20, None))`
	`48`	`+>>> check_slice_get_indices( slice( 20, None))`
`49`	`49`	`0`
`50`		`->>> check_slice_get_indicies( slice( -2, -5, -2))`
	`50`	`+>>> check_slice_get_indices( slice( -2, -5, -2))`
`51`	`51`	`6`
`52`	`52`	`"""`
`53`	`53`