expose hampel method. bump version

Author: aozisik

package.json

@@ -1,14 +1,17 @@
 {
   "name": "labkar-algorithms",
-  "version": "1.0.2",
+  "version": "2.0.0",
   "description": "Labkar Algorithms",
   "main": "dist/lib.js",
   "scripts": {
     "test": "jest",
     "test:watch": "jest --watchAll",
     "build": "tsc"
   },
-  "files": ["dist/*.js", "dist/**/*.js"],
+  "files": [
+    "dist/*.js",
+    "dist/**/*.js"
+  ],
   "dependencies": {
     "average": "^1.0.0",
     "compute-stdev": "^1.0.0",

src/algorithms/q-hampel.ts

@@ -2,7 +2,7 @@ const { jStat } = require('jstat');
 import { median } from 'simple-statistics';
 import { get, sortBy, sumBy, round, sortedUniq, findIndex } from 'lodash';
 
-import { QHampelResult } from '../types';
+import { Result } from '../types';
 
 interface Q_Options {
   precision: number;
@@ -16,10 +16,10 @@ interface Q_Calculation {
   g: number;
 }
 
-export function QHampel(
+export function Q(
   results: number[],
   options: Q_Options = { precision: 8 }
-): QHampelResult {
+): Result {
   const { precision } = options;
 
   const values: number[] = ([] as number[]).concat(results).sort();
@@ -76,7 +76,6 @@ export function QHampel(
 
   return {
     value,
-    hampel: hampel(results, value),
   };
 }
 
@@ -90,7 +89,7 @@ function calculateG(i: number, h: number, hPrevious: number) {
   }
 }
 
-function hampel(results: number[], q: number) {
+export function Hampel(results: number[], q: number): Result {
   if (q === 0) {
     return { value: 0 };
   }
@@ -135,5 +134,7 @@ function hampel(results: number[], q: number) {
 
   let x = median(values);
 
-  return calculateRecursive(values, x);
+  return {
+    value: calculateRecursive(values, x),
+  };
 }

src/types.ts

@@ -1,8 +1,4 @@
 export type Result = {
   value: number;
-  uncertainty?: number;  
-};
-export type QHampelResult = {
-  value: number;  
-  hampel: number;  
+  uncertainty?: number;
 };

tests/algorithms.test.ts

@@ -1,4 +1,4 @@
-import { MADe, M_Estimator, QHampel } from '../src/lib';
+import { MADe, M_Estimator, Q, Hampel } from '../src/lib';
 
 describe('Algorithms', () => {
   it('MADe Method', () => {
@@ -17,7 +17,7 @@ describe('Algorithms', () => {
     expect(output.uncertainty).toBeCloseTo(1.118405, 3);
   });
 
-  it('Q-Hampel Method', () => {
+  it('Q Method', () => {
     const samples = [
       41.41, 39.22, 47.29, 82.46, 45.24, 49.96, 38.2, 45.41, 39.82, 48.17,
       39.67, 47.55, 35.75, 46.13, 52.18, 45.15, 41.57, 43.39, 49.38, 45.67,
@@ -28,10 +28,25 @@ describe('Algorithms', () => {
       48.61, 44.18,
     ];
 
-    const output = QHampel(samples);      
+    const output = Q(samples);
 
     expect(output.value).toBeCloseTo(5.5457, 3);
-    expect(output.hampel).toBeCloseTo(44.722, 3);
-    
+    // expect(output.hampel).toBeCloseTo(44.722, 3);
+  });
+
+  it('Hampel Method', () => {
+    const samples = [
+      41.41, 39.22, 47.29, 82.46, 45.24, 49.96, 38.2, 45.41, 39.82, 48.17,
+      39.67, 47.55, 35.75, 46.13, 52.18, 45.15, 41.57, 43.39, 49.38, 45.67,
+      41.08, 49.28, 49.48, 48.37, 33.96, 49.4, 24.4, 41.55, 37.43, 40.63, 49.92,
+      47.88, 43.73, 38.1, 38.1, 46.82, 90.11, 45.74, 53.4, 42.65, 47.92, 42.02,
+      49.47, 43.89, 50.05, 37.41, 53.64, 56.3, 47.13, 39.08, 44.73, 47, 50.53,
+      44.22, 47.83, 46.04, 47, 36.3, 46.44, 24.79, 46.26, 39.88, 38.64, 50.19,
+      48.61, 44.18,
+    ];
+
+    const output = Hampel(samples, Q(samples).value);
+
+    expect(output.value).toBeCloseTo(44.722, 3);
   });
 });