set-promotion-count

set-promotion-count Function

Summary

Controls when objects can be promoted to the next generation in 32-bit LispWorks. This function is deprecated.

Package

hcl

Signature

set-promotion-count gen-num count &optional segment => effective-count

Arguments

`gen-num`⇩	The generation number affected.
`count`⇩	A positive integer or `nil`.
`segment`⇩	A non-negative integer.

Values

effective-count⇩

A positive integer.

Description

The function set-promotion-count controls how many garbage collections an object in a segment must survive before promotion to the next generation.

gen-num specifies the generation number affected.

count specifies the number of garbage collections survived by objects in gen-num, before promotion. If count is nil, the function just returns the current promotion count setting.

segment specifies which segment in gen-num is to be affected. The default is 0, meaning the lowest segment of the generation.

set-promotion-count returns effective-count, which is count if that is non-nil or the current promotion count otherwise.

Notes

set-promotion-count is deprecated, because experience has shown that it is not useful.
set-promotion-count is implemented only in 32-bit LispWorks. It is not relevant to the Memory Management API in 64-bit implementations, wherein you may be able to achieve the effect with set-delay-promotion.