Meeting June 1: Implement Changes in Template Code and Standardize Array Variable Names

thisisashukla commented 7 years ago

Implement Changes in Template Code

Modify generated template files to suit the needs of the desired function
- [x] Modify sql\areaContraction\areaContraction.sql file
- [x] Modify src\areaContraction\src\areaContraction.c file
- [x] Modify drivers\areaContraction\areaContraction_driver.h file
- [x] Modify src\areaContraction\src\areaContraction_driver.cpp file
[ ] Fix Travis Warnings
[ ] Fix Appveyor Warnings
[ ] Fix Documentation tests
[ ] Fix pgTap Tests

thisisashukla commented 7 years ago

Standardized Array Variable Names

New Standard for Array Variable names and array size variable names as proposed by Vicky Vergara: Proposed Standard

thisisashukla commented 7 years ago

Pointers on Code

Use TODO to make reminders in the code
- //TODO "write your comment"

thisisashukla commented 7 years ago

Study the signatures of pgr_contractGraph and pgr_dijkstra_many_to_many

[ ] Compare the signatures of the following:
- pgr_contractGraph
- pgr_dijkstra_many_to_many
[ ] Think is the comparison is trivial or not

thisisashukla commented 7 years ago

Pointers on creating a new function

So, suppose I start to create a new function, pgr_foo at the begining I just have the template's code and that is using pgr_dijkstra but pgr_foo its not going to do a dikstra, it is going to do a Foo and Foo is the code that has to be written while its not written, or its half way written
- no documetation tests will pass
- no pgtap tests will pass
So, to avoid tests on pgr_foo in src/foo/test/test.conf
- [ ] Delete the test from the array
In tools/testesrs/pg_prove_tests.sh
- [ ] Comment out the line that include the pgtap tests. Tests will be reactivated & maybe redesigned when you finish the code and you need to start testing
Try to commit as often as possible, and push at the end of the day
One thing for sure, the other function's tests must pass but testing locally can take a long time so while working locally test that this is not affected tools/testers/algorithm-tester.pl -alg dijkstra
- [ ] Uncomment that from your run.sh
- [ ] and comment out all other tests
In any case when the push is done, all the tests of the other functions will be performed on Travis and they all should pass
In the development
- [x] Change this Pgr_dijkstra< G > fn_dijkstra; return fn_dijkstra.dijkstra(graph, 0, 0); to return Path()
Basically what is done is:
- For any input you return no results which is correct, because you have no function coded yet
[x] Change General_path_t to a new structure with a convenient name, that might be useful for the other functions which will be coded in future. Do that in here: https://github.com/XJTUmg/pgrouting/tree/gsoc/connectComponent/include/c_types once you create the structure, modify the C/C++ code with the new structure
[x] 'tests' => [qw(doc-connectedComponentsV)] to 'tests' => []
[ ] 'pending_tests' => [qw(doc-connectedComponentsV)]
Run the tests, and change the result file
That is an example:
- Results are different on different operating systems some tests are for developing but not part of the documentation, so for release they are in a section that the script does not test note, its pending_tests with an underscore delete the test from documentation, because otherwise, if I run the test to generate documentation results that will be executed and you don't want that now maybe later, but not now
[x] 'documentation' => [qw(doc-connectedComponentsV)] change it to 'documentation' => [ ]

thisisashukla commented 7 years ago

Few pointers on Git: Recover Deleted Files

git checkout -b recover/deletedFiles
git log
git checkout concerned commit .
git checkout -b oldCommit
git checkout recover/deletedFiles
git diff --name-only oldCommit
git checkout file
git status
git commit -a -m 'recovered deleted files`
git checkout original_branch
git merge recover/deletedFiles
git push

thisisashukla commented 7 years ago

Discussion on the standard for array size variable

A) size_t size_borderVertices = 0; B) size_t size_border_vertices = 0; C) size_t border_vertices_size = 0;

My Reason for choosing B:

Size_my_array_1 is read as size of array 1 and when there are lots of array variables, in C code we will have a mix of my_array_1and size_my_array_1 or my_array_1_size then size as a prefix clearly differentiates my_array_1 from size_my_array_1 when reading from the left.

Vicky Vergara's Reason for choosing C:

The afterlife aka after GSoC finishes I want people to focus more on the C++ code than of the C code so making C look more as the C++ code (myArray1.size()) is more valuable for me.

size_t border_vertices_size = 0; prevails as the standard for array size variables

thisisashukla commented 7 years ago

Working of C templates

References:

thisisashukla / pgrouting

Meeting June 1: Implement Changes in Template Code and Standardize Array Variable Names #22