# iterLucasSeq > Create an iterator which generates a [Lucas sequence][lucas-number].
The [Lucas numbers][lucas-number] are the integer sequence
Lucas sequence
The sequence is defined by the recurrence relation
Lucas sequence recurrence relation
## Usage ```javascript var iterLucasSeq = require( '@stdlib/math/iter/sequences/lucas' ); ``` #### iterLucasSeq( \[options] ) Returns an iterator which generates a [Lucas sequence][lucas-number]. ```javascript var it = iterLucasSeq(); // returns var v = it.next().value; // returns 2 v = it.next().value; // returns 1 v = it.next().value; // returns 3 // ... ``` The returned iterator protocol-compliant object has the following properties: - **next**: function which returns an iterator protocol-compliant object containing the next iterated value (if one exists) assigned to a `value` property and a `done` property having a `boolean` value indicating whether the iterator is finished. - **return**: function which closes an iterator and returns a single (optional) argument in an iterator protocol-compliant object. The function supports the following `options`: - **iter**: number of iterations. Default: `77`. The returned iterator can only generate the first `77` [Lucas numbers][lucas-number], as larger [Lucas numbers][lucas-number] cannot be safely represented in [double-precision floating-point format][ieee754]. By default, the function returns an iterator which generates all `77` numbers. To limit the number of iterations, set the `iter` option. ```javascript var opts = { 'iter': 2 }; var it = iterLucasSeq( opts ); // returns var v = it.next().value; // returns 2 v = it.next().value; // returns 1 var bool = it.next().done; // returns true ```
## Notes - If an environment supports `Symbol.iterator`, the returned iterator is iterable.
## Examples ```javascript var iterLucasSeq = require( '@stdlib/math/iter/sequences/lucas' ); // Create an iterator: var it = iterLucasSeq(); // Perform manual iteration... var v; while ( true ) { v = it.next(); if ( v.done ) { break; } console.log( v.value ); } ```
[lucas-number]: https://en.wikipedia.org/wiki/Lucas_number [ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985