Skip to content

Improve documentation and add main evolution simulation#1

Open
MatejGomboc-Claude-MCP wants to merge 20 commits intoMatejGomboc:masterfrom
MatejGomboc-Claude-MCP:improve-documentation-and-features
Open

Improve documentation and add main evolution simulation#1
MatejGomboc-Claude-MCP wants to merge 20 commits intoMatejGomboc:masterfrom
MatejGomboc-Claude-MCP:improve-documentation-and-features

Conversation

@MatejGomboc-Claude-MCP
Copy link
Copy Markdown

@MatejGomboc-Claude-MCP MatejGomboc-Claude-MCP commented Jun 28, 2025

Summary

This PR significantly improves the Evolution-Simulation project by adding comprehensive documentation, a main simulation program, example files, and new biological simulation features.

Changes Made

📚 Documentation

  • Updated README.md with:
    • Project overview and features
    • Complete instruction set documentation including new biological instructions
    • Build instructions
    • Usage examples
    • Project structure guide
    • Detailed biological simulation mechanics

🚀 New Features

Main Evolution Simulation Program (evolution-sim/)

  • Complete evolutionary algorithm implementation
  • Organism class wrapping programs with fitness evaluation
  • Tournament selection for parent selection
  • Elitism to preserve best solutions
  • Generation statistics tracking
  • Command-line parameter support

🧬 Biological Simulation Features

  • Energy System:

    • Organisms start with 100 energy units
    • Energy depletes over time (1 unit per step)
    • Death occurs when energy reaches 0
    • Food provides 30 energy units
    • Mating costs 20 energy units per parent
  • New Instructions:

    • MATE_REQUEST: Request mating with another organism
    • MATE_ACCEPT: Accept a mating request from another organism
    • CONSUME_FOOD: Attempt to consume food for energy
    • ROCK_PAPER_SCISSORS: Conflict resolution mechanism
  • Conflict Resolution System:

    • First: Rock-paper-scissors game
    • If tied: Higher energy wins
    • If still tied: Random selection (Bernoulli distribution)
  • World Management:

    • Manages organisms, food, and interactions
    • Tracks mating requests and acceptances
    • Handles food consumption
    • Updates organism states and removes dead organisms

📝 Examples

  • Created examples/ directory with sample programs:
    • simple_math.txt - Basic arithmetic operations
    • loop_example.txt - Loop control flow demonstration
    • condition_example.txt - Conditional execution
    • logic_operations.txt - Logical operations
    • biological_behavior.txt - Food consumption and mating
    • mating_sequence.txt - Mating request/acceptance flow
    • survival_strategy.txt - Complex survival behaviors
    • conflict_resolution.txt - Rock-paper-scissors example

🔧 Improvements

  • Added comprehensive documentation to program.h using Doxygen-style comments
  • Added missing s0.txt test file for test-save-load
  • Updated CMakeLists.txt files to include new components
  • Created biological_sim.h/cpp for biological simulation components

Implementation Details

Biological Components

  • Organism: Extended with energy, age, and mating capabilities
  • Food: Consumable items that restore energy
  • World: Manages all entities and their interactions
  • MatingRequest: Tracks mating proposals between organisms

Energy Dynamics

  • Natural selection favors organisms with better energy management
  • Energy acts as both a fitness metric and survival requirement
  • Creates pressure for efficient food-finding behaviors

Genetic Inheritance

  • Offspring inherit traits from parents
  • Mutation rate controls program variation
  • Population dynamics with extinction possibility

Testing

The changes maintain backward compatibility while adding new functionality. The existing test-save-load program now has the required test file and should run successfully.

Build Instructions

mkdir build
cd build
cmake ..
make

# Run the biological evolution simulation
./evolution-sim/evolution-sim [population_size] [mutation_rate] [generations] [food_spawn_rate]

# Example
./evolution-sim/evolution-sim 100 0.15 200 30

Future Enhancements

This PR lays the groundwork for further improvements:

  • More sophisticated fitness functions based on behavior
  • Crossover operations between parent programs
  • Mutation operators for individual instructions
  • Performance benchmarks
  • GUI visualization of evolution progress
  • Spatial environment with organism movement
  • Predator-prey dynamics
  • Resource competition strategies

Thank you for creating this interesting genetic programming framework! The biological features add a new dimension of realism to the evolution simulation, allowing for emergent behaviors related to survival, reproduction, and resource management.

- Add project overview and features
- Document the instruction set
- Add build instructions
- Include usage examples
- Document project structure
- Keep original license information
- Create Organism class to wrap programs with fitness
- Implement EvolutionSimulation class with:
  - Population management
  - Fitness evaluation
  - Tournament selection
  - Evolution with elitism
  - Statistics tracking
- Add command line argument parsing
- Demonstrate basic evolutionary loop
- simple_math.txt: Demonstrates basic arithmetic operations
- loop_example.txt: Shows loop control flow 
- condition_example.txt: Demonstrates conditional execution
- logic_operations.txt: Shows logical operations
- Add class documentation explaining the Program concept
- Document all public constants
- Add detailed method documentation
- Explain the role of each private member
- Use Doxygen-style comments for better documentation generation
- Create simple test program with basic instructions
- Ensures test-save-load can run successfully
- MATE_REQUEST: Request mating with another organism
- CONSUME_FOOD: Attempt to consume food
- MATE_ACCEPT: Accept mating request
- ROCK_PAPER_SCISSORS: For conflict resolution
- Add Organism class with energy system
- Add Food class for consumption
- Add World class to manage interactions
- Add mating request/acceptance system
- Add rock-paper-scissors conflict resolution
- Define energy constants and depletion rates
- Implement energy depletion and management
- Implement mating request/acceptance logic
- Implement food consumption
- Implement rock-paper-scissors conflict resolution
- Add world update logic to remove dead organisms
- Simple genetic inheritance for offspring
- MateRequest takes partner index address and result address
- Reads partner ID from memory
- Stores success/failure result in memory
- Will interface with World class in main simulation
- ConsumeFood takes food index address and result address
- Reads food ID from memory
- Stores success/failure result in memory
- Will interface with World class for actual consumption
- MateAccept takes requester index address and result address
- Reads requester ID from memory
- Stores success/failure result in memory
- Will trigger actual mating process in World class
- Takes choice address, opponent address, and result address
- Reads choice (0=rock, 1=paper, 2=scissors) and opponent ID
- Stores game result (-1=loss, 0=tie, 1=win) in memory
- Will interface with World class for actual game resolution
- Add biological_sim.cpp and biological_sim.h
- Add new instruction implementations:
  - mate_request
  - consume_food
  - mate_accept
  - rock_paper_scissors
- Add includes for new instruction types
- Add string parsing factories for:
  - MATE_REQUEST
  - CONSUME_FOOD
  - MATE_ACCEPT
  - ROCK_PAPER_SCISSORS
- Add byte array parsing factories for all new instructions
- Implement proper parameter parsing for each instruction type
- Replace basic simulation with BiologicalEvolutionSimulation
- Integrate World class for organism management
- Add energy-based survival and natural selection
- Implement mating and reproduction with energy costs
- Add food consumption simulation
- Add conflict resolution using the defined system
- Track age, energy, and fitness for each organism
- Implement population dynamics with extinction possibility
- Add comprehensive statistics including energy and age
- Update overview to mention biological features
- Add biological instructions to instruction set
- Document energy system and depletion mechanics
- Explain mating and reproduction system
- Document conflict resolution process
- Add command line parameters for evolution-sim
- Include biological simulation details section
- Update project structure with new files
- biological_behavior.txt: Shows food consumption and mating requests
- mating_sequence.txt: Demonstrates mating request and acceptance
- survival_strategy.txt: Complex behavior with food, conflict, and mating
- conflict_resolution.txt: Rock-paper-scissors conflict example
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant