Merge pull request torch#391 from hughperkins/short-explanation-of-ke…

…y-values-sort description that sort orders the 'key' tensor numerically
marsbzp · Apr 15, 2016 · bf8f88b · bf8f88b
2 parents adc1e54 + 3025080
commit bf8f88b
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/lib/THC/THCTensorSort.cu b/lib/THC/THCTensorSort.cu
@@ -106,6 +106,9 @@ void THCudaTensor_fillSliceWithIndex(THCState* state,
   THCudaCheck(cudaGetLastError());
 }
 
+// In alignment with default sort on a c++ map, this function
+// will permute key and value tensors identically, and
+// in such a way that the 'key' tensor is ordered numerically
 THC_API void THCudaTensor_sortKeyValueInplace(THCState* state,
                                               THCudaTensor* key,
                                               THCudaTensor* value,