Skip to content

Commit

Permalink
Added @correctness section
Browse files Browse the repository at this point in the history
  • Loading branch information
r-barnes committed Sep 17, 2016
1 parent d243e51 commit 0682713
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 5 deletions.
2 changes: 1 addition & 1 deletion doxy.conf
Expand Up @@ -228,7 +228,7 @@ TAB_SIZE = 4
# "Side Effects:". You can put \n's in the value part of an alias to insert
# newlines.

ALIASES =
ALIASES += correctness="\par Correctness:\n"

# This tag can be used to specify a number of word-keyword mappings (TCL only).
# A mapping has the form "name=value". For example adding "class=itcl::class"
Expand Down
26 changes: 22 additions & 4 deletions include/richdem/depressions/priority_flood.hpp
Expand Up @@ -37,6 +37,9 @@
1. **elevations** contains the elevations of every cell or a value _NoData_
for cells not part of the DEM.
2. **elevations** contains no landscape depressions or digital dams.
@correctness
The correctness of this command is determined by inspection. (TODO)
*/
template <class elev_t>
void original_priority_flood(Array2D<elev_t> &elevations){
Expand Down Expand Up @@ -91,9 +94,9 @@ void original_priority_flood(Array2D<elev_t> &elevations){
}
progress.update(processed_cells);
}
std::cerr<<"\t\033[96msucceeded in "<<progress.stop()<<"s.\033[39m"<<std::endl;
std::cerr<<"m Cells processed = "<<processed_cells<<std::endl;
std::cerr<<"m Cells in pits = " <<pitc <<std::endl;
std::cerr<<"t Succeeded in = "<<progress.stop() <<" s"<<std::endl;
std::cerr<<"m Cells processed = "<<processed_cells <<std::endl;
std::cerr<<"m Cells in pits = "<<pitc <<std::endl;
}


Expand Down Expand Up @@ -122,6 +125,9 @@ void original_priority_flood(Array2D<elev_t> &elevations){
1. **elevations** contains the elevations of every cell or a value _NoData_
for cells not part of the DEM.
2. **elevations** contains no landscape depressions or digital dams.
@correctness
The correctness of this command is determined by inspection. (TODO)
*/
template <class elev_t>
void improved_priority_flood(Array2D<elev_t> &elevations){
Expand Down Expand Up @@ -188,7 +194,7 @@ void improved_priority_flood(Array2D<elev_t> &elevations){
}
progress.update(processed_cells);
}
std::cerr<<"\t\033[96msucceeded in "<<std::fixed<<std::setprecision(1)<<progress.stop()<<"s.\033[39m"<<std::endl;
std::cerr<<"t Succeeded in "<<std::fixed<<std::setprecision(1)<<progress.stop()<<" s"<<std::endl;
std::cerr<<"m Cells processed = "<<processed_cells<<std::endl;
std::cerr<<"m Cells in pits = " <<pitc <<std::endl;
}
Expand Down Expand Up @@ -218,6 +224,9 @@ void improved_priority_flood(Array2D<elev_t> &elevations){
1. **elevations** contains the elevations of every cell or a value _NoData_
for cells not part of the DEM.
2. **elevations** has no landscape depressions, digital dams, or flats.
@correctness
The correctness of this command is determined by inspection. (TODO)
*/
template <class elev_t>
void priority_flood_epsilon(Array2D<elev_t> &elevations){
Expand Down Expand Up @@ -361,6 +370,9 @@ void priority_flood_epsilon(Array2D<int32_t> &elevations){
_NO_FLOW_ for those cells which are not part of the DEM.
2. **flowdirs** has no cells which are not part of a continuous flow
path leading to the edge of the DEM.
@correctness
The correctness of this command is determined by inspection. (TODO)
*/
template <class elev_t>
void priority_flood_flowdirs(const Array2D<elev_t> &elevations, Array2D<int8_t> &flowdirs){
Expand Down Expand Up @@ -468,6 +480,9 @@ void priority_flood_flowdirs(const Array2D<elev_t> &elevations, Array2D<int8_t>
@post
1. **pit_mask** contains a 1 for each cell which is in a pit and a 0 for
each cell which is not.
@correctness
The correctness of this command is determined by inspection. (TODO)
*/
//TODO: Can I use a smaller data type?
template <class elev_t>
Expand Down Expand Up @@ -579,6 +594,9 @@ void pit_mask(const Array2D<elev_t> &elevations, Array2D<int32_t> &pit_mask){
**alter_elevations** was set.
2. **labels** contains a label for each cell indicating its membership in a
given watershed. Cells bearing common labels drain to common points.
@correctness
The correctness of this command is determined by inspection. (TODO)
*/
template<class elev_t>
void priority_flood_watersheds(
Expand Down

0 comments on commit 0682713

Please sign in to comment.