numopt-js 0.2.0 → 0.3.0

package/CODING_RULES.md

@@ -1,161 +1,161 @@
-# Coding Rules
-
-This document defines the coding standards for numopt-js.
-
-## 1. No Magic Numbers
-
-All numeric constants must be named constants with clear meaning.
-
-**Bad:**
-```typescript
-if (lambda > 1e-6) {
-  // ...
-}
-```
-
-**Good:**
-```typescript
-const MINIMUM_LAMBDA_THRESHOLD = 1e-6;
-if (lambda > MINIMUM_LAMBDA_THRESHOLD) {
-  // ...
-}
-```
-
-## 2. File Header Comments
-
-Every file must start with a comment explaining:
-- What the file does
-- Its role in the overall system
-- Guidance for first-time readers
-
-**Example:**
-```typescript
-/**
- * This file implements the Levenberg-Marquardt algorithm for solving
- * nonlinear least squares problems.
- * 
- * Role in system:
- * - Core optimization algorithm (Phase 3)
- * - Builds upon Gauss-Newton method (Phase 2)
- * - Uses numerical differentiation utilities
- * 
- * For first-time readers:
- * - Start with the main function `levenbergMarquardt`
- * - Understand the lambda update strategy
- * - Check convergence criteria implementation
- */
-```
-
-## 3. No Abbreviations
-
-Function and variable names must be self-documenting. Obvious conventions like `i` for loop counters are acceptable.
-
-**Bad:**
-```typescript
-function calcJ(p: Float64Array): Matrix {
-  // ...
-}
-```
-
-**Good:**
-```typescript
-function computeJacobianMatrix(parameters: Float64Array): Matrix {
-  // ...
-}
-```
-
-## 4. Comment Philosophy: WHY, not WHAT
-
-Comments should explain **WHY**, not **WHAT**. Code should be self-explanatory.
-
-**Bad:**
-```typescript
-// Calculate the gradient
-const gradient = computeGradient(parameters);
-```
-
-**Good:**
-```typescript
-// Using central difference instead of forward difference for better accuracy
-// at the cost of one additional function evaluation per parameter
-const gradient = computeGradient(parameters);
-```
-
-## 5. Variable Naming Awareness
-
-Distinguish between:
-- **Constants** (never change): `UPPER_SNAKE_CASE`
-- **Configurable values** (may change): `camelCase` with clear names
-- **User-provided values** (user can change): `camelCase` with descriptive names
-
-**Example:**
-```typescript
-const MAXIMUM_ITERATIONS = 1000; // Constant
-const stepSize = options.stepSize ?? DEFAULT_STEP_SIZE; // Configurable
-const userProvidedParameters = initialParams; // User-provided
-```
-
-## 6. Function Length Limit
-
-Functions must not exceed 50 lines. Break down complex functions into smaller, focused functions.
-
-## 7. No Deep Nesting
-
-Use early returns and guard clauses to reduce nesting depth.
-
-**Bad:**
-```typescript
-function processData(data: Data) {
-  if (data !== null) {
-    if (data.isValid) {
-      if (data.values.length > 0) {
-        // process...
-      }
-    }
-  }
-}
-```
-
-**Good:**
-```typescript
-function processData(data: Data) {
-  if (data === null) return;
-  if (!data.isValid) return;
-  if (data.values.length === 0) return;
-  
-  // process...
-}
-```
-
-## 8. DRY Principle
-
-Strictly avoid code duplication. Extract common logic into reusable functions.
-
-**Bad:**
-```typescript
-function computeA() {
-  const result = expensiveComputation();
-  return result * 2;
-}
-
-function computeB() {
-  const result = expensiveComputation();
-  return result * 3;
-}
-```
-
-**Good:**
-```typescript
-function expensiveComputation(): number {
-  // ...
-}
-
-function computeA(): number {
-  return expensiveComputation() * 2;
-}
-
-function computeB(): number {
-  return expensiveComputation() * 3;
-}
-```
-
+# Coding Rules
+
+This document defines the coding standards for numopt-js.
+
+## 1. No Magic Numbers
+
+All numeric constants must be named constants with clear meaning.
+
+**Bad:**
+```typescript
+if (lambda > 1e-6) {
+  // ...
+}
+```
+
+**Good:**
+```typescript
+const MINIMUM_LAMBDA_THRESHOLD = 1e-6;
+if (lambda > MINIMUM_LAMBDA_THRESHOLD) {
+  // ...
+}
+```
+
+## 2. File Header Comments
+
+Every file must start with a comment explaining:
+- What the file does
+- Its role in the overall system
+- Guidance for first-time readers
+
+**Example:**
+```typescript
+/**
+ * This file implements the Levenberg-Marquardt algorithm for solving
+ * nonlinear least squares problems.
+ * 
+ * Role in system:
+ * - Core optimization algorithm (Phase 3)
+ * - Builds upon Gauss-Newton method (Phase 2)
+ * - Uses numerical differentiation utilities
+ * 
+ * For first-time readers:
+ * - Start with the main function `levenbergMarquardt`
+ * - Understand the lambda update strategy
+ * - Check convergence criteria implementation
+ */
+```
+
+## 3. No Abbreviations
+
+Function and variable names must be self-documenting. Obvious conventions like `i` for loop counters are acceptable.
+
+**Bad:**
+```typescript
+function calcJ(p: Float64Array): Matrix {
+  // ...
+}
+```
+
+**Good:**
+```typescript
+function computeJacobianMatrix(parameters: Float64Array): Matrix {
+  // ...
+}
+```
+
+## 4. Comment Philosophy: WHY, not WHAT
+
+Comments should explain **WHY**, not **WHAT**. Code should be self-explanatory.
+
+**Bad:**
+```typescript
+// Calculate the gradient
+const gradient = computeGradient(parameters);
+```
+
+**Good:**
+```typescript
+// Using central difference instead of forward difference for better accuracy
+// at the cost of one additional function evaluation per parameter
+const gradient = computeGradient(parameters);
+```
+
+## 5. Variable Naming Awareness
+
+Distinguish between:
+- **Constants** (never change): `UPPER_SNAKE_CASE`
+- **Configurable values** (may change): `camelCase` with clear names
+- **User-provided values** (user can change): `camelCase` with descriptive names
+
+**Example:**
+```typescript
+const MAXIMUM_ITERATIONS = 1000; // Constant
+const stepSize = options.stepSize ?? DEFAULT_STEP_SIZE; // Configurable
+const userProvidedParameters = initialParams; // User-provided
+```
+
+## 6. Function Length Limit
+
+Functions must not exceed 50 lines. Break down complex functions into smaller, focused functions.
+
+## 7. No Deep Nesting
+
+Use early returns and guard clauses to reduce nesting depth.
+
+**Bad:**
+```typescript
+function processData(data: Data) {
+  if (data !== null) {
+    if (data.isValid) {
+      if (data.values.length > 0) {
+        // process...
+      }
+    }
+  }
+}
+```
+
+**Good:**
+```typescript
+function processData(data: Data) {
+  if (data === null) return;
+  if (!data.isValid) return;
+  if (data.values.length === 0) return;
+  
+  // process...
+}
+```
+
+## 8. DRY Principle
+
+Strictly avoid code duplication. Extract common logic into reusable functions.
+
+**Bad:**
+```typescript
+function computeA() {
+  const result = expensiveComputation();
+  return result * 2;
+}
+
+function computeB() {
+  const result = expensiveComputation();
+  return result * 3;
+}
+```
+
+**Good:**
+```typescript
+function expensiveComputation(): number {
+  // ...
+}
+
+function computeA(): number {
+  return expensiveComputation() * 2;
+}
+
+function computeB(): number {
+  return expensiveComputation() * 3;
+}
+```
+

package/LICENSE

@@ -1,22 +1,22 @@
-MIT License
-
-Copyright (c) 2024 numopt-js contributors
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
+MIT License
+
+Copyright (c) 2024 numopt-js contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+