pnmatrix 1.2.4

data/ext/nmatrix/storage/list/list.h

@@ -0,0 +1,138 @@
+/////////////////////////////////////////////////////////////////////
+// = NMatrix
+//
+// A linear algebra library for scientific computation in Ruby.
+// NMatrix is part of SciRuby.
+//
+// NMatrix was originally inspired by and derived from NArray, by
+// Masahiro Tanaka: http://narray.rubyforge.org
+//
+// == Copyright Information
+//
+// SciRuby is Copyright (c) 2010 - 2014, Ruby Science Foundation
+// NMatrix is Copyright (c) 2012 - 2014, John Woods and the Ruby Science Foundation
+//
+// Please see LICENSE.txt for additional copyright notices.
+//
+// == Contributing
+//
+// By contributing source code to SciRuby, you agree to be bound by
+// our Contributor Agreement:
+//
+// * https://github.com/SciRuby/sciruby/wiki/Contributor-Agreement
+//
+// == list.h
+//
+// List-of-lists n-dimensional matrix storage. Uses singly-linked
+// lists.
+
+#ifndef LIST_H
+#define LIST_H
+
+/*
+ * Standard Includes
+ */
+
+#include <ruby.h>
+#include <cstdlib>
+#include <list>
+/*
+ * Project Includes
+ */
+
+#include "types.h"
+#include "data/data.h"
+#include "../common.h"
+#include "util/sl_list.h"
+#include "nmatrix.h"
+
+/*
+ * Macros
+ */
+
+/*
+ * Types
+ */
+
+
+
+/*
+ * Data
+ */
+ 
+extern "C" {
+
+  /*
+   * Functions
+   */
+
+  ////////////////
+  // Lifecycle //
+  ///////////////
+
+  LIST_STORAGE*  nm_list_storage_create(nm::dtype_t dtype, size_t* shape, size_t dim, void* init_val);
+  void          nm_list_storage_delete(STORAGE* s);
+  void          nm_list_storage_delete_ref(STORAGE* s);
+  void          nm_list_storage_mark(STORAGE*);
+  void          nm_list_storage_register(const STORAGE* s);
+  void          nm_list_storage_unregister(const STORAGE* s);
+  void          nm_list_storage_register_list(const LIST* l, size_t recursions);
+  void          nm_list_storage_unregister_list(const LIST* l, size_t recursions);
+  void          nm_list_storage_register_node(const NODE* n);
+  void          nm_list_storage_unregister_node(const NODE* n);
+  void          nm_list_storage_completely_unregister_node(const NODE* curr);
+  ///////////////
+  // Accessors //
+  ///////////////
+
+  VALUE nm_list_each_with_indices(VALUE nmatrix, bool stored);
+  void* nm_list_storage_ref(const STORAGE* s, SLICE* slice);
+  void* nm_list_storage_get(const STORAGE* s, SLICE* slice);
+  NODE* nm_list_storage_insert(STORAGE* s, SLICE* slice, void* val);
+  void  nm_list_storage_set(VALUE left, SLICE* slice, VALUE right);
+  void  nm_list_storage_remove(STORAGE* s, SLICE* slice);
+
+  ///////////
+  // Tests //
+  ///////////
+
+  bool nm_list_storage_eqeq(const STORAGE* left, const STORAGE* right);
+
+  //////////
+  // Math //
+  //////////
+
+  STORAGE* nm_list_storage_matrix_multiply(const STORAGE_PAIR& casted_storage, size_t* resulting_shape, bool vector);
+
+
+  /////////////
+  // Utility //
+  /////////////
+
+  size_t nm_list_storage_count_elements_r(const LIST* l, size_t recursions);
+  size_t nm_list_storage_count_nd_elements(const LIST_STORAGE* s);
+
+  /*
+   * Count non-zero elements. See also count_list_storage_nd_elements.
+   */
+  inline size_t nm_list_storage_count_elements(const LIST_STORAGE* s) {
+    return nm_list_storage_count_elements_r(s->rows, s->dim - 1);
+  }
+
+  /////////////////////////
+  // Copying and Casting //
+  /////////////////////////
+
+  LIST_STORAGE* nm_list_storage_copy(const LIST_STORAGE* rhs);
+  STORAGE*      nm_list_storage_copy_transposed(const STORAGE* rhs_base);
+  STORAGE*      nm_list_storage_cast_copy(const STORAGE* rhs, nm::dtype_t new_dtype, void*);
+  VALUE         nm_list_storage_to_hash(const LIST_STORAGE* s, const nm::dtype_t dtype);
+
+  // Exposed functions
+  VALUE nm_to_hash(VALUE self);
+  VALUE nm_list_map_merged_stored(VALUE left, VALUE right, VALUE init);
+  VALUE nm_list_map_stored(VALUE left, VALUE init);
+  VALUE nm_list_default_value(VALUE self);
+} // end of extern "C" block
+
+#endif // LIST_H