# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

Types of changes:
 - *Added* for new features.
 - *Changed* for changes in existing functionality.
 - *Deprecated* for soon-to-be removed features.
 - *Removed* for now removed features.
 - *Fixed* for any bug fixes.
 - *Security* in case of vulnerabilities.


## \[unreleased\]
- A show case of integration testing, knowledge from <https://doc.rust-lang.org/rust-by-example/testing/integration_testing.html>
- A show case of performance (benchmark) testing, knowledge from <https://doc.rust-lang.org/rust-by-example/testing/integration_testing.html> and <https://crates.io/crates/criterion>

## [1.3.1] -2024-7-20
- add method as_regex() and refactor method get_regex() in XRegex struct
- fix documentation accordingly
-  add par_matching_indices in correlation module
## [1.3.0] -2024-7-9
### Added
- method matching_indices in ReSequence
## [1.2.0] -2024-5-5
### Added
- macro xregex!()
ref:<https://blog.jetbrains.com/rust/2022/03/18/procedural-macros-under-the-hood-part-i/>, <https://stackoverflow.com/questions/60790226/custom-literals-via-rust-macros> <https://internals.rust-lang.org/t/pre-rfc-custom-literals-via-traits/8050>
## [1.1.1] -2024-4-28
### Added
- is_empty() method created for XRegex and ReSequence
### Fixed
- improve source code according to lint warnings.
## [1.1.0] -2024-4-26
### Added
- Patterns can be annotated into regex sets by into_reu and into_res functions in module assembly.
### Fixed
- example documentation in lib.rs and README.md

## [1.0.2] -2024-4-19
### Fixed
- samples of regex literals
## [1.0.1] -2024-3-17
### Fixed
- README.md
## [1.0.0] -2024-3-1
### Added
- module assembly in `w` feature
- documentation test and unit test

## [0.9.8] - 2024-1-4
### Added
- Module delimited defines the core data structures ReSequence, XRegex, and the
 associated intermediate data (LiteralForm and Meta); it also includes the 
 execution procedures of `parse` and `compile` for converting literals of 
 regular expressions and sets to regular expression structures.