Merge pull request #56 from phpsci/1.0-dev

1.0 dev

Author: henrique-borba

config.h.in~

@@ -110,9 +110,12 @@ PHP_NEW_EXTENSION(carray,
       kernel/convert_type.c \
       kernel/trigonometric.c \
       kernel/matlib.c \
+      kernel/statistics.c \
+      kernel/arraytypes.c \
       kernel/join.c \
       kernel/ctors.c \
       kernel/scalar.c \
+      kernel/round.c \
       kernel/getset.c \
       kernel/common/strided_loops.c \
       kernel/convert_datatype.c \

config.m4

@@ -1,13 +1,45 @@
-## take
+# Indexing Routines
 
-## take_along_axis
+---
 
-## choose
+## diagonal
 
-## compress
+```php
+public static diagonal($a, int $offset = 0, int $axis1 = 0, int $axis2 = 0) : CArray
+```
+> Return specified diagonals.
 
-## diag
+> If a is 2-D, returns the diagonal of a with the given offset, i.e., the collection of elements of the 
+form `$a[i][i+offset]`. If a has more than two dimensions, then the axes specified by axis1 and axis2 are used to 
+determine the 2-D sub-array whose diagonal is returned. The shape of the resulting array can be determined by 
+removing axis1 and axis2 and appending an index to the right equal to the size of the resulting diagonals.
 
-## diagonal
+##### Parameters
+
+`CArray|Array` **$a** - Input array.
+
+`CArray|Array` **$offset** (optional) - Offset of the diagonal from the main diagonal. Can be positive or negative. Defaults to 
+main diagonal (0).
+
+`CArray|Array` **$axis1** (optional) - Axis to be used as the first axis of the 2-D sub-arrays from which the diagonals should be taken. 
+Defaults to first axis (0).
+
+`CArray|Array` **$axis2** (optional) - Axis to be used as the second axis of the 2-D sub-arrays from which the diagonals should be 
+taken. Defaults to second axis (1).
+
+##### Returns
+
+`CArray` Diagonals of `$a`.
+
+##### Examples
+
+**Example 1**
+```php
+$A = CArray::arange(4);
+$A = CArray::reshape($A, [2, 2]);
+echo CArray::diagonal($A);
+```
+````
+[ 0  3 ]
+````
 
-## select

docs/routines/indexing.md

@@ -1,11 +1,77 @@
-## eye
+# Ones and Zeros Routines
+
+---
 
 ## identity
 
-## ones
+```php
+public static identity($n) : CArray
+```
+> Return the identity array.
+
+> The identity array is a square array with ones on the main diagonal.
+
+##### Parameters
+
+`CArray|Array` **$n** Number of rows (and columns) in `$n x $n` output.
+
+##### Returns
+
+`CArray` `$n x $n` CArray with its main diagonal set to one, and all other elements 0.
+         
+##### Examples
+
+**Example 1**
+```php
+echo CArray::identity(4);
+```
+```
+[[ 1.  0.  0.  0. ]
+ [ 0.  1.  0.  0. ]
+ [ 0.  0.  1.  0. ]
+ [ 0.  0.  0.  1. ]]
+```
+
+---
+
+## eye
 
-## ones_like
+```php
+public static eye($n, $m = NULL, $k = 0) : CArray
+```
+
+> Return a 2-D array with ones on the diagonal and zeros elsewhere.
+
+##### Parameters
+
+`CArray|Array` **$n** Number of rows in the output.
+
+`CArray|Array` **$m** Number of columns in the output. If NULL, defaults to `$n`.
+
+`CArray|Array` **$k** Index of the diagonal: 0 (the default) refers to the main diagonal, a positive value refers to 
+an upper diagonal, and a negative value to a lower diagonal.
+
+##### Returns
+
+`CArray` An array where all elements are equal to zero, except for the `$k`-th diagonal, whose values are equal to one.
+
+##### Examples
+
+**Example 1**
+```php
+echo CArray::eye(3, 3, 1);
+```
+```
+[[ 0.  1.  0. ]
+ [ 0.  0.  1. ]
+ [ 0.  0.  0. ]]
+```         
+         
+         
+---
+
+## ones
 
-## zeros
+---
 
-## zeros_like
+## zeros

docs/routines/ones_and_zeros.md

@@ -0,0 +1,61 @@
+# Rearranging Routines
+
+---
+
+## reshape
+
+```php
+public static reshape($a, $newshape) : CArray
+```
+> Gives a new shape to an array without changing its data.
+
+##### Parameters
+
+`CArray|Array` **$a** Input array.
+
+`CArray|Array` **$newshape** The new shape should be compatible with the original shape. If an integer, then the result 
+will be a 1-D array of that length.
+
+##### Returns
+
+`CArray` This will be a new view of `$a` if possible; otherwise, it will be a copy.
+
+##### Examples
+
+**Example 1**
+```php
+$A = CArray::arange(8);
+echo CArray::reshape($A, [2, 4]);
+```
+````
+[[ 0  1  2  3 ]
+ [ 4  5  6  7 ]]
+````
+
+---
+
+## flip
+
+```php
+public static flip($a) : CArray
+```
+> Reverse the order of elements in an array
+
+##### Parameters
+
+`CArray|Array` **$a** Input array.
+
+##### Returns
+
+`CArray` A view of `$a` with the entries of axis reversed. 
+
+##### Examples
+
+**Example 1**
+```php
+$A = CArray::arange(8);
+echo CArray::flip($A);
+```
+```
+[ 7  6  5  4  3  2  1  0 ]
+```

docs/routines/rearranging.md

@@ -2,8 +2,6 @@
 
 ---
 
-## reshape
-
 ## ravel
 
 ## CArray::$flat

docs/routines/shape.md

@@ -5,8 +5,11 @@
 void
 CArrayDescriptor_FREE(CArrayDescriptor * descr)
 {
-    efree(descr->f);
-    efree(descr);
+    if (descr->refcount <= 0) {
+        efree(descr->f);
+        efree(descr);
+        descr = NULL;
+    }
 }
 
 /**
@@ -72,17 +75,22 @@ CArrayDescriptor_INCREF(CArrayDescriptor * descriptor)
 void
 CArrayDescriptor_DECREF(CArrayDescriptor * descriptor)
 {
-    descriptor->refcount--;
+    if (descriptor != NULL) {
+        descriptor->refcount--;
+    }
 }
 
 void
 CArray_Free(CArray * self)
 {
+    if (self->descriptor != NULL) {
+        if (self->descriptor->refcount <= 0) {
+            CArrayDescriptor_FREE(self->descriptor);
+        }
+    }
     if(self->refcount <= 0) {
         efree(self->dimensions);
         efree(self->strides);
-        efree(self->descriptor->f);
-        efree(self->descriptor);
         efree(self->data);
         efree(self);
     } else {