directions.h File Reference

#include "scs.h"

Go to the source code of this file.

Macros
#define	SCS_DIRECTION_CACHE_INCREMENT   101
#define	SCS_DIRECTION_CACHE_RESET   100
#define	SCS_DIRECTION_ERROR   -1
#define	SCS_DIRECTION_SUCCESS   0

Functions
scs_int	scs_reset_direction_cache (ScsDirectionCache *cache)
scs_int	scs_compute_dir_restarted_broyden (ScsWork *work)
scs_int	scs_compute_dir_anderson (ScsWork *work)
scs_int	scs_compute_dir_full_broyden (ScsWork *work, scs_int i)
void	scs_free_full_broyden (void)
scs_int	scs_compute_direction (ScsWork *work, scs_int i)

Macro Definition Documentation

#define SCS_DIRECTION_CACHE_INCREMENT   101

The cache has been incremented.

#define SCS_DIRECTION_CACHE_RESET   100

The cursor of the cache has been reset to 0.

#define SCS_DIRECTION_ERROR   -1

The direction could not be computed due to an error.

#define SCS_DIRECTION_SUCCESS   0

The direction was computed successfully.

All nonnegative status codes denote success.

Function Documentation

scs_int scs_compute_dir_anderson

(

ScsWork *

work

)

Anderson's acceleration

Parameters

work	Work structure with all available information about the current iteration (current FPR, values of \(s_k\), \(y_k\) etc).

Returns

status code of the method.

scs_int scs_compute_dir_full_broyden	(	ScsWork *	work,
		scs_int	i
	)

Full Broyden method.

Parameters

work
i

Returns

status code of the method.

See Also

Full Broyden Algorithm

Warning

Not implemented yet

scs_int scs_compute_dir_restarted_broyden

(

ScsWork *

work

)

Restarted Broyden (as it is reported in the paper).

Parameters

work	Work structure with all available information about the current iteration (current FPR, values of \(s_k\), \(y_k\) etc).

Returns

status code of the method.

See Also

Restarted Broyden Algorithm

scs_int scs_compute_direction	(	ScsWork *	work,
		scs_int	i
	)

Computes a direction according to the value of work->stgs->direction.

Parameters

work	workspace structure
i	iteration count

Returns

status code; negative status corresponds to error.

See Also

ScsDirectionType

void scs_free_full_broyden

(

void

)

Frees memory allocated for the full Broyden method.

scs_int scs_reset_direction_cache

(

ScsDirectionCache *

cache

)

Resets the cache. This methods does not free the memory allocated by the cache, nor does it overwrite the previously cached data. It simply sets the parameters mem_current and mem_idx to 0.

Parameters

cache

the cache to be reset

Returns

status code (returns SCS_DIRECTION_CACHE_RESET)