search

TheHortonMachine / hortonmachine

The Horton Machine
http://thehortonmachine.github.io/hortonmachine/
GNU General Public License v3.0
43 stars 25 forks source link

Documentation for "pMode" parameter field of Kriging module looks wrong #10

Closed rafaelalmeida closed 9 years ago

rafaelalmeida commented 9 years ago

In the Javadoc for this field, it is said that the value can be 0, 1, 2 or 3. However, in the very beginning of verifyInput() only values 0 or 1 are accepted.

This is a bit confusing, especially because the semantics for pMode == 1 seems to be reversed: Javadoc says it means irregular grid, while the rest of the source seems to mean regular grid.

I can submit a Pull Request myself to fix this, if my understanding is correct. Is it?

Edit: correcting values

moovida commented 9 years ago

Hi @rafaelalmeida , thanks for this. Yes, the 4 modes were originally available but when the port was done 2 of them didn't seem to make much sense. The original authors never decided to contribute the rest, so I agree with you, it is better to remove them. The javadoc is still an old copy/paste.

A pull request would be much appreciated, thanks.

moovida commented 9 years ago

merged in