Changeset 2730 for trunk/src/BufferedBisectionLocator.h

Timestamp:

01/16/13 16:00:28 (11 years ago)

Author:

Takeshi Nakazato

Message:

New Development: No

JIRA Issue: Yes CAS-4770

Ready for Test: Yes

Interface Changes: No

What Interface Changed: Please list interface changes

Test Programs: List test programs

Put in Release Notes: Yes/No?

Module(s): Module Names change impacts.

Description: Describe your changes here...

Rewrite implementations for locator and interpolator.
Documentation (doxygen format) is added to header files.

File:

• trunk/src/BufferedBisectionLocator.h (modified) (1 diff)

trunk/src/BufferedBisectionLocator.h

@@ -18 +18 @@
 
 /**
- * Implementation of locate operation by bisection search 
+ * Implementation of locate operation by bisection search with 
+ * some buffer.
  * @author TakeshiNakazato
  */
 class BufferedBisectionLocator : public Locator {
 public:
-  BufferedBisectionLocator() {;}
-  BufferedBisectionLocator(double *v, unsigned int n);
+  // Default constructor.
+  BufferedBisectionLocator();
 
+  // Construct with data
+  // @param[in] v pointer to input data.
+  // @param[in] n length of the data.
+  // @param[in] copystorage whether allocate internal memory or not.
+  // @see Locator::set()
+  BufferedBisectionLocator(double *v, unsigned int n, bool copystorage=true);
+
+  // Destructor.
   virtual ~BufferedBisectionLocator();
 
+  // Return right hand side index of location using bisection search.
+  // @param[in] x input value to be located.
+  // @return location as an index j.
+  // @see Locator::locate()
   unsigned int locate(double x);
 private:
+
+  // Previous location index.
   unsigned int prev_;
 };