Skip to content

Main content

BFGS Optimizer Step Calculator Source Code

Browse the implementation files for BFGS Optimizer Step Calculator.
tool.ts typescript
import { parseFiniteNumber } from '../../parse/number/tool';

const round = (value: number): number =>
	Number(value.toPrecision(12));

export const calculateBfgsStep = (
	previousParameterInput: unknown,
	parameterInput: unknown,
	previousGradientInput: unknown,
	gradientInput: unknown,
	inverseHessianInput: unknown,
	learningRateInput: unknown
): string => {
	const previousParameter = parseFiniteNumber(
		previousParameterInput
	);
	const parameter = parseFiniteNumber(parameterInput);
	const previousGradient = parseFiniteNumber(
		previousGradientInput
	);
	const gradient = parseFiniteNumber(gradientInput);
	const inverseHessian = parseFiniteNumber(inverseHessianInput);
	const learningRate = parseFiniteNumber(learningRateInput);
	if (
		[
			previousParameter,
			parameter,
			previousGradient,
			gradient,
			inverseHessian,
			learningRate
		].some((value) => value === null) ||
		inverseHessian! <= 0 ||
		learningRate! <= 0
	)
		return '';

	const displacement = parameter! - previousParameter!;
	const gradientChange = gradient! - previousGradient!;
	if (
		displacement * gradientChange <= 0 ||
		gradientChange === 0
	)
		return '';
	const nextInverseHessian = displacement / gradientChange;
	const direction = -nextInverseHessian * gradient!;
	const nextParameter = parameter! + learningRate! * direction;
	if (
		![nextInverseHessian, direction, nextParameter].every(
			Number.isFinite
		)
	)
		return '';
	return JSON.stringify(
		{
			direction: round(direction),
			inverseHessian: round(nextInverseHessian),
			parameter: round(nextParameter)
		},
		null,
		2
	);
};

export const Tool: TypeTool = {
	name: 'BFGS Optimizer Step Calculator',
	slug: 'optimization/bfgs-step',
	intro:
		'Calculate a scalar BFGS inverse-Hessian update and the next parameter step.',
	tool: calculateBfgsStep,
	i: [
		{
			example: '0',
			label: 'Previous Parameter',
			placeholder: 'Previous x',
			type: 'number'
		},
		{
			example: '1',
			label: 'Current Parameter',
			placeholder: 'Current x',
			type: 'number'
		},
		{
			example: '-4',
			label: 'Previous Gradient',
			placeholder: 'Previous gradient',
			type: 'number'
		},
		{
			example: '-2',
			label: 'Current Gradient',
			placeholder: 'Current gradient',
			type: 'number'
		},
		{
			example: '1',
			label: 'Previous Inverse Hessian',
			placeholder: 'Positive scalar estimate',
			type: 'number'
		},
		{
			example: '1',
			label: 'Learning Rate',
			placeholder: 'Positive step scale',
			type: 'number'
		}
	],
	o: [
		{
			example: '{ "parameter": 2 }',
			label: 'BFGS Step',
			placeholder: 'Updated state will appear here...',
			render: 'textarea',
			type: 'text'
		}
	]
};

export default Tool;

Description

Browse the implementation files for BFGS Optimizer Step Calculator.

References

  1. Tool.io on GitHub
  2. Tool.io TypeScript tools library

Similar or alternative tools