Class PointFromLineDistance

Calculates the distance between a point and a line.

See

https://en.wikipedia.org/wiki/Distance_from_a_point_to_a_line

Hierarchy

Procedures.Procedure<{
    line: {
        a: number;
        b: number;
        c: number;
    };
    point: {
        x: number;
        y: number;
    };
}, {
    distance: number;
}>
- PointFromLineDistance

Index

Constructors

constructor

new PointFromLineDistance(): PointFromLineDistance
Returns PointFromLineDistance
Overrides Procedure.constructor
- Defined in src/procedures/foundational/distance.ts:10

Accessors

name

get name(): string
Name of the procedure.

Returns string
Inherited from Procedure.name
- Defined in src/procedures/procedure.ts:21

Methods

evaluate

evaluate(input): {
distance: number;
}
Performs the evaluation. Should be a pure function.
Parameters
- input: {
      line: {
          a: number;
          b: number;
          c: number;
      };
      point: {
          x: number;
          y: number;
      };
  }
  
  The input data.
  - line: {
        a: number;
        b: number;
        c: number;
    }
    - a: number
    - b: number
    - c: number
  - point: {
    x: number;
    y: number;
    }
    - x: number
    - y: number
Returns {
distance: number;
}
The output data.
- distance: number
Inherited from Procedure.evaluate
- Defined in src/procedures/procedure.ts:34

perform

perform(input): {
distance: number;
}
Performs the procedure.
Parameters
- input: {
      line: {
          a: number;
          b: number;
          c: number;
      };
      point: {
          x: number;
          y: number;
      };
  }
  - line: {
        a: number;
        b: number;
        c: number;
    }
    - a: number
    - b: number
    - c: number
  - point: {
    x: number;
    y: number;
    }
    - x: number
    - y: number
Returns {
distance: number;
}
- distance: number
Inherited from Procedure.perform
- Defined in src/procedures/procedure.ts:28

Class PointFromLineDistance

See

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns PointFromLineDistance

Accessors

name

Returns string

Methods

evaluate

Parameters

input: { line: { a: number; b: number; c: number; }; point: { x: number; y: number; }; }

line: { a: number; b: number; c: number; }

a: number

b: number

c: number

point: { x: number; y: number; }

x: number

y: number

Returns { distance: number; }

distance: number

perform

Parameters

input: { line: { a: number; b: number; c: number; }; point: { x: number; y: number; }; }

line: { a: number; b: number; c: number; }

a: number

b: number

c: number

point: { x: number; y: number; }

x: number

y: number

Returns { distance: number; }

distance: number

Settings

Member Visibility

Theme

On This Page

input: {
line: {
a: number;
b: number;
c: number;
};
point: {
x: number;
y: number;
};
}

line: {
a: number;
b: number;
c: number;
}

point: {
x: number;
y: number;
}

Returns {
distance: number;
}

input: {
line: {
a: number;
b: number;
c: number;
};
point: {
x: number;
y: number;
};
}

line: {
a: number;
b: number;
c: number;
}

point: {
x: number;
y: number;
}

Returns {
distance: number;
}