aboutsummaryrefslogblamecommitdiffstats
path: root/README.asciidoc
blob: 27cf6d1cb5673c7360b8cba60d62a23d1440df3d (plain) (tree)
1
2
3
4
5
6
7
      
 


                                                                                     
                                                              
 


































































































































































                                                                                
= meow

.Links
* https://github.com/cathook/meow[GitHub]
* http://www.csie.ntu.edu.tw/~b01902109/readme/template_meow/README.html[README.html]
* https://github.com/cathook/meow/archive/master.zip[Download]

== Introduction

Template *Meow* is a set of templates in multiple programming language.  Most of
them doesn't need to compile before using, developer can just include it to get
the classes/functions in it.

=== Git branches:

* master: The release version, which doesn't not contain the testing code.
* develop: It's contains all the source in this project, includes testing code
    and the documents generated by doxygen in addition.

=== Brief introduction about File Tree:

* '.doxygen/' Data for generating the documents of this project.
* '.readme/' Data for generating the readme file.
* 'doc/' Contains the documents of this project.
** 'html/' Documents in HTML format.
*** 'index.html' Home page.
* 'moewpp/' C++ Templates.
** '...' (See below for detail introduction)
* 'meowpp_unittest/' Unittest code for meowpp.
* 'meowjs/' JS library (Not implement yet).
** '...' (See below for detail introduction)
* 'meowjs_unittest/' Unittest code for meowjs.


== Meowpp

=== Introduction

TODO(cathook): Fill it.

=== 'meowpp/algo/'

* 'levenberg_marquardt.h'
* 'pla.h'
* 'ppla.h'
* 'rasnac.h'

=== 'meowpp/debug/'

* 'assert.h'

=== 'meowpp/ds/'

* 'binary_index_tree.h'
* 'disjoint_set.h'
* 'half_plane.h'
* 'hash_table.h'
* 'kd_tree.h'
* 'mergeable_heap.h'
* 'segment_tree.h'
* 'splay_tree.h'
* 'treap.h'
* 'vp_tree.h'

=== 'meowpp/geo/'

* 'ball.h'
* 'circle.h'
* 'convex_mash.h'
* 'convex_polygon.h'
* 'line_segment.h'
* 'mash3.h'
* 'plane.h'
* 'polygon.h'
* 'radial.h'
* 'simple_polygon.h'
* 'oper/'
** 'intersection.h'
** 'union.h'
** 'minus.h'
** 'area.h'
** 'convex_hull.h'
* 'vector2d.h'
* 'vector3d.h'
* 'voronoi.h'

=== 'meowpp/math/'

* 'matrix.h'
* 'oper/'
** 'gaussian_elimination.h'
** 'ldu_factor.h'
** 'trans/'
*** 'transformation.h'
*** 'ball_projection.h'
*** 'linear_projection.h'
*** 'offset.h'
*** 'photo_porjection.h'
*** 'rotation2d.h'
*** 'rotation3d.h'
*** 'scale.h'
* 'vector.h'

=== 'meowpp/tools/'

* 'usage.h'

=== 'meowpp/utility/'

* 'factory.h'
* 'object.h'
* 'operation.h'
* 'pointer.h'
* 'self.h'
* 'state.h'

=== 'meowpp/gra/'

* 'images/'
** 'image.h'
** 'bmp.h'
** 'jpg.h'
** 'pyramid.h'
** 'oper/'
*** 'bmp_to_jpg.h'
*** 'dog.h'
*** 'find_features/'
**** 'harris_corner_detect.h'
**** 'sift.h'
*** 'gaussian_blur.h'
*** 'log.h'
* 'pixel3/'
** 'pixel3.h'
** 'rgb_f.h'
* 'pixel4/'
** 'pixel4.h'
** 'rgba_f.h'


== Testing

TODO(cathook): Fill it.

== Copyright

This program is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any later
version.


This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE.  See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with
this program.  If not, see <http://www.gnu.org/licenses/>.


== Authors/Bug Report

=== cathook

- E-mail: cat.hook <AT> gmail.com
- github: https://www.github.com/cathook/meow

=== cat_leopard

- E-mail: b01902109 %at% csie.ntu.edu.tw/
- E-mail: b01902109 %at% ntu.edu.tw